VEvercel
ai-gateway

Create a BYOK credential

Changed on

Create a new BYOK credential

post/ai-gateway/byok-credentials

Request

  • Base URL
    https://api.vercel.com
  • URL
    https://api.vercel.com/ai-gateway/byok-credentials
  • Auth
    HTTP bearer

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

ownerIdstring

The owner ID for this credential. Ignored for customer tokens, which always create in their own team.

providerSlugstring required

The provider slug this credential is for (e.g., "openai", "anthropic")

namestring required

The developer-entered name for this credential

activeboolean

Whether the credential is active and can be used

zeroDataRetentionboolean

Whether the customer attested this external credential has a zero data retention policy

userIdstring

The ID of the user performing this action, used for Activity-log attribution.

Response

activefalse | true required
createdAtnumber required
credentialIdstring required
lastFourCharsstring required
namestring required
ownerIdstring required
providerSlugstring required
rotatedAtnumber nullable required
updatedAtnumber required
zeroDataRetentionfalse | true required

Changes