Revoke an API key

curl --request DELETE \
  --url https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/api-keys/{apiKeyId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/api-keys/{apiKeyId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/api-keys/{apiKeyId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "object": "knowledge_base.api_key",
  "deleted": true
}

DELETE

knowledge_bases

{knowledgeBaseId}

api-keys

{apiKeyId}

Revoke an API key

curl --request DELETE \
  --url https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/api-keys/{apiKeyId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/api-keys/{apiKeyId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{host}/v2/workspaces/slug:storage/webhooks/v1/knowledge_bases/{knowledgeBaseId}/api-keys/{apiKeyId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.delete(url, headers=headers)

print(response.text)

{
  "object": "knowledge_base.api_key",
  "deleted": true
}

Authorizations

Authorization

string

header

required

User session JWT or instance API key (iak_*). Send as Authorization: Bearer <token>.

Path Parameters

knowledgeBaseId

string

required

Knowledge base id. Legacy physical prefix vs_ (the kb_ rename is deferred).

Maximum string length: 128

Pattern: ^vs_[A-Za-z0-9-]+$

apiKeyId

string

required

Knowledge-base API key identifier - the key slug (auto-generated as kb-{knowledge_base_id}-{uuid}, or caller-supplied). This is the value returned as ApiKey.id.

Maximum string length: 128

Pattern: ^kb-[A-Za-z0-9_-]+$

Response

Revoked.

object

enum<string>

required

Available options:

knowledge_base.api_key

deleted

enum<boolean>

required

Available options:

true

Mint an API key Rotate an API key

⌘I

Introduction

Platform API

Agent Creator API

LLM Gateway API

Governance API

Knowledges API

Revoke an API key

Authorizations

Path Parameters

Response