Skip to content
Docs

List BYOK credentials

GET/__remote/api.vercel.com/ai-gateway/byok-credentials/list
List BYOK credentials for an owner, optionally filtered by provider
/__remote/api.vercel.com/ai-gateway/byok-credentials/list
const response = await fetch('/__remote/api.vercel.com/ai-gateway/byok-credentials/list?ownerId=string&providerSlug=string&includeDeleted=string&decrypt=string&includeModelMappings=string&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "credentials": [
    {
      "active": "false",
      "createdAt": "123",
      "credential": "string",
      "credentialId": "example_id",
      "deleted": "false",
      "lastFourChars": "string",
      "modelMappings": [
        {
          "customModelId": "example_id",
          "gatewayModelSlug": "string"
        }
      ],
      "name": "Example Name",
      "ownerId": "example_id",
      "providerSlug": "example_id",
      "updatedAt": "123",
      "zeroDataRetention": "false"
    }
  ]
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

ownerIdstringOptional
The owner ID to list credentials for. Ignored for customer tokens, which always list their own team.
providerSlugstringOptional
Optional provider slug to filter credentials by
includeDeletedstringOptional
Whether to include soft-deleted credentials
decryptstringOptional
Not supported. Credential values are never returned.
includeModelMappingsstringOptional
Whether to include model mappings for each credential in the response
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
credentialsarrayRequired

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error
500Error