Skip to main content
GET
/
v1
/
user
/
byok
/
{provider}
cURL
curl --request GET \
  --url https://{deployment}.convex.site/v1/user/byok/{provider}
{
  "hasKey": true,
  "apiKey": "sk-..."
}

Path Parameters

provider
string
required
Minimum string length: 1
Example:

"openai"

Response

200 - application/json

BYOK key status

hasKey
boolean
required
Example:

true

apiKey
string | null
required

Decrypted API key, only returned when key exists

Example:

"sk-..."