POST /api-keys
Servers
- https://api.vercel.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
projectId |
String | No |
An optional project to restrict the API key to. |
name |
String | No |
An optional name for the API key. |
expiresAt |
Number | No |
The API key's expiration, expressed as a UNIX timestamp in milliseconds. |
purpose |
String | Yes |
The API key's purpose, which restricts how it can be used. |
aiGatewayQuota |
Object | No |
Optional AI Gateway quota configuration for the API key. |
aiGatewayQuota.includeByokInQuota |
Boolean | No |
Whether to include BYOK (Bring Your Own Key) usage in the quota. Default value: false |
aiGatewayQuota.limitAmount |
Number | Yes |
The quota limit amount. |
aiGatewayQuota.alertThresholds[] |
Array | No |
Spend percentages (a subset of [50, 75, 100]) at which to send a spend alert. |
aiGatewayQuota.refreshPeriod |
String | No |
How often the quota refreshes. Valid values:
Default value: "none" |
metadata |
Object | No |
Optional generic metadata for the API key. The accepted shape depends on the key's |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.