Create a BYOK credential | Edgenivo REST API

APIs & SDKs

Create a BYOK credential

POST/__remote/api.vercel.com/ai-gateway/byok-credentials

Create a new BYOK credential

/__remote/api.vercel.com/ai-gateway/byok-credentials

const response = await fetch('/__remote/api.vercel.com/ai-gateway/byok-credentials?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "ownerId": "example_id",
    "providerSlug": "example_id",
    "name": "Example Name",
    "active": "true",
    "zeroDataRetention": "true",
    "userId": "example_id",
    "mappings": [
      {
        "gatewayModelSlug": "string",
        "customModelId": "example_id"
      }
    ]
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "active": "false",
  "createdAt": "123",
  "credentialId": "example_id",
  "lastFourChars": "string",
  "name": "Example Name",
  "ownerId": "example_id",
  "providerSlug": "example_id",
  "updatedAt": "123",
  "zeroDataRetention": "false"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

ownerIdstringOptional

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

providerSlugstringRequired

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

namestringRequired

The developer-entered name for this credential

activebooleanOptional

Whether the credential is active and can be used

zeroDataRetentionbooleanOptional

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

userIdstringOptional

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

mappingsarrayOptional

Model mappings to create atomically with the credential (e.g. Azure deployments). One DynamoDB transaction holds the credential plus all mappings, so at most 99 mappings fit.

Response

201Success

activebooleanRequired

createdAtnumberRequired

credentialIdstringRequired

lastFourCharsstringRequired

namestringRequired

ownerIdstringRequired

providerSlugstringRequired

updatedAtnumberRequired

zeroDataRetentionbooleanRequired

Errors

400One of the provided values in the request body is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

429Error

500Error

/__remote/api.vercel.com/ai-gateway/byok-credentials

const response = await fetch('/__remote/api.vercel.com/ai-gateway/byok-credentials?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "ownerId": "example_id",
    "providerSlug": "example_id",
    "name": "Example Name",
    "active": "true",
    "zeroDataRetention": "true",
    "userId": "example_id",
    "mappings": [
      {
        "gatewayModelSlug": "string",
        "customModelId": "example_id"
      }
    ]
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "active": "false",
  "createdAt": "123",
  "credentialId": "example_id",
  "lastFourChars": "string",
  "name": "Example Name",
  "ownerId": "example_id",
  "providerSlug": "example_id",
  "updatedAt": "123",
  "zeroDataRetention": "false"
}

OpenAPI Specification