@unkey/api
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
86 lines (61 loc) • 6.21 kB
Markdown
(*apis*)
* [createApi](
```typescript
import { Unkey } from "@unkey/api";
const unkey = new Unkey({
rootKey: "UNKEY_ROOT_KEY",
});
async function run() {
const result = await unkey.apis.createApi({
name: "my-api",
});
// Handle the result
console.log(result);
}
run();
```
The standalone function version of this method:
```typescript
import { UnkeyCore } from "@unkey/api/core.js";
import { apisCreateApi } from "@unkey/api/funcs/apisCreateApi.js";
// Use `UnkeyCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const unkey = new UnkeyCore({
rootKey: "UNKEY_ROOT_KEY",
});
async function run() {
const res = await apisCreateApi(unkey, {
name: "my-api",
});
if (!res.ok) {
throw res.error;
}
const { value: result } = res;
// Handle the result
console.log(result);
}
run();
```
| Parameter | Type | Required | Description |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `request` | [components.V2ApisCreateApiRequestBody](../../models/components/v2apiscreateapirequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
| `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
**Promise\<[components.V2ApisCreateApiResponseBody](../../models/components/v2apiscreateapiresponsebody.md)\>**
| Error Type | Status Code | Content Type |
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
| errors.BadRequestErrorResponse | 400 | application/json |
| errors.UnauthorizedErrorResponse | 401 | application/json |
| errors.ForbiddenErrorResponse | 403 | application/json |
| errors.InternalServerErrorResponse | 500 | application/json |
| errors.APIError | 4XX, 5XX | \*/\* |