curl --request PATCH \
--url https://api.talkpilot.io/v1/api-keys/{keyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_active": false
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key_prefix": "tp_live_a1",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_name": "<string>",
"created_by_email": "<string>",
"is_own": true,
"permissions": [
"agents:read"
],
"allowed_agent_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rate_limit_per_minute": 123,
"rate_limit_per_hour": 123,
"is_active": true,
"last_used_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}API Keys
Update an API key
Update key metadata (name, permissions, rate limits, active status). The key value itself cannot be changed — create a new key instead.
Requires Supabase JWT authentication.
PATCH
/
v1
/
api-keys
/
{keyId}
curl --request PATCH \
--url https://api.talkpilot.io/v1/api-keys/{keyId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"is_active": false
}
'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"key_prefix": "tp_live_a1",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_name": "<string>",
"created_by_email": "<string>",
"is_own": true,
"permissions": [
"agents:read"
],
"allowed_agent_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"rate_limit_per_minute": 123,
"rate_limit_per_hour": 123,
"is_active": true,
"last_used_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}Authorizations
Supabase JWT token (for Dashboard-only endpoints like API key management)
Path Parameters
Body
application/json
Maximum string length:
255Available permissions:
agents:read— List and view agent configurationsagents:write— Update agent settingsemployees:read— List and view employeesemployees:write— Create, update, delete employeestools:read— List and view agent toolstools:write— Create, update, delete toolsforwarding:read— List forwarding slotsforwarding:write— Create, update, delete forwarding slotskb:read— List and view knowledge base documentskb:write— Create, update, delete KB documentscalls:read— List and view call recordsorganization:read— View organization settingsorganization:write— Update organization settingscontacts:read— List and view contacts (customer database)contacts:write— Create, update, delete contacts
Available options:
agents:read, agents:write, employees:read, employees:write, tools:read, tools:write, forwarding:read, forwarding:write, kb:read, kb:write, calls:read, organization:read, organization:write, contacts:read, contacts:write Required range:
1 <= x <= 600Required range:
1 <= x <= 10000Response
Updated API key info
API key metadata (the actual key value is never returned after creation)
First 10 characters of the key for identification
Example:
"tp_live_a1"
Home organization of the key (key management only)
Name of the home organization (list endpoint only)
Email of the creator; null for legacy keys (list endpoint only)
Whether the requesting user created this key (list endpoint only)
Available permissions:
agents:read— List and view agent configurationsagents:write— Update agent settingsemployees:read— List and view employeesemployees:write— Create, update, delete employeestools:read— List and view agent toolstools:write— Create, update, delete toolsforwarding:read— List forwarding slotsforwarding:write— Create, update, delete forwarding slotskb:read— List and view knowledge base documentskb:write— Create, update, delete KB documentscalls:read— List and view call recordsorganization:read— View organization settingsorganization:write— Update organization settingscontacts:read— List and view contacts (customer database)contacts:write— Create, update, delete contacts
Available options:
agents:read, agents:write, employees:read, employees:write, tools:read, tools:write, forwarding:read, forwarding:write, kb:read, kb:write, calls:read, organization:read, organization:write, contacts:read, contacts:write Restrict key to specific agents (null = all agents in organization)