Get BYOK Credential

Returns a specific BYOK credential associated to a credential_id.

Get BYOK Credential API Documentation

This endpoint GET /v1/byok/{credential_id} retrieves a specific BYOK item with the given credential_id value.

API Request

Sending Request

bash
curl -X GET "https://api.zoice.com/v1/byok/cred_a8f7407278" \
  -H "Authorization: Bearer $ZOICE_API_KEY"

Response Format

json
{
  "status": "success",
  "credential": {
    "credential_id": "cred_a8f7407278...",
    "provider": "elevenlabs",
    "key_name": "elevenlabs personal",
    "masked_api_key": "sk_3e75...681c",
    "key_status": "active"
  }
}

Schemas

Input

Path Parameter

Type

Required

Default

Range

credential_id

string

Yes

-

-

Output

Field

Type

Description

status

string

The status of the API request.

Allowed values: "success", "processing", "failed"

credential

object

Object with credential information.

credential.key_status

string

The current status of the key.

Allowed values: "active", "expired", "disabled"

credential.credential_id

string

The unique identifier associated with the credential.

credential.key_name

string

The name of the credential.

credential.provider

string

The third-party provider associated with the credential, for eg., "elevenlabs".

credential.masked_api_key

string

The API key used to set up the credential in masked form.