Deactivate Keys

Deactivate API keys either in bulk by request_id or individually.

Option A — Deactivate by request ID: Pass a request_id in the request body to deactivate all keys from that generation request.

Option B — Deactivate individual key: Set the key you want to deactivate in the Authorization header. No request body is required.

POST /deactivate-keys

Deactivate API Keys

cURL

curl --request POST \
  --url https://api-key-generator.tavily.com/deactivate-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "request_id": "550e5678-e29b-41d4-a716-446655441234"
}
'

200

{
  "message": "Successfully deactivated 5 key(s)"
}

Who can use this feature?
This feature is available on the Enterprise plan. Talk to an expert to learn more.

Authorizations

Authorization · string · header · required

Bearer authentication header in the form Bearer , where is your Tavily API key (e.g., Bearer tvly-YOUR_API_KEY).

Body

application/json

Optionally provide a request_id to bulk-deactivate keys. If omitted, the key in the Authorization header is deactivated.

request_id · string

The request ID from a previous /generate-keys call. All keys from that request will be deactivated.

Example:

"550e5678-e29b-41d4-a716-446655441234"

Response

200 - application/json

Keys deactivated successfully.

message · string

A confirmation message.

Example:

"Successfully deactivated 5 key(s)"