Skip to main content
PATCH
/
api
/
v1
/
settings
/
byok
Toggle BYOK on/off
curl --request PATCH \
  --url https://app.autousers.ai/api/v1/settings/byok \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'
{
  "hasKey": true,
  "enabled": true,
  "provider": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.autousers.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

Client-generated idempotency key (≤255 chars). Replays the cached response when the same (team, key) pair sees an identical request body within 24h; returns 409 idempotency_key_reused if the body differs. Recommended for every billable POST.

Maximum string length: 255
​
Autousers-Version
string

Date-pinned API version (e.g. 2026-05-04). Omit to receive the latest stable version. Behaves like Stripe's Stripe-Version — pinning a version freezes payload shapes against breaking changes during the 12-month sunset window.

Body

application/json
​
enabled
boolean
required

Response

Updated

​
hasKey
boolean
required
​
enabled
boolean
required
​
provider
string | null
​
{key}
any