Skip to content
Docs

Get a BYOK credential

GET/__remote/api.vercel.com/ai-gateway/byok-credentials/{credentialId}
Get a BYOK credential by ID. The credential value is never returned.
/__remote/api.vercel.com/ai-gateway/byok-credentials/{credentialId}
const response = await fetch('/__remote/api.vercel.com/ai-gateway/byok-credentials/credentialId?ownerId=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
{
  "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

Path parameters

credentialIdstringRequired
The unique ID of the credential

Query parameters

ownerIdstringOptional
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
activebooleanRequired
createdAtnumberRequired
credentialIdstringRequired
lastFourCharsstringRequired
namestringRequired
ownerIdstringRequired
providerSlugstringRequired
updatedAtnumberRequired
zeroDataRetentionbooleanRequired

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