Assistant APICheck a key

Check a key

Returns whether the key works now and what it answers from, for setup screens. For a valid key it returns 200, with any problem reported in the body. It counts towards the key's rate limit like every request.

curl -X GET "https://api.documentation.ai/api/v1/assistant/key" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "ready": true,
  "problem": null,
  "problem_message": null,
  "name": "Support inbox",
  "integration": "intercom",
  "caller": "server",
  "access": "public",
  "answers_from": "all_pages",
  "access_roles": [],
  "allowed_origins": [],
  "requests_per_minute": 60,
  "expires_at": "2027-11-11T09:30:00.000Z"
}
GET
/key
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An Assistant API key from Settings > Assistant API: the secret key (asst_sk_...) from servers and tools, or the publishable key (asst_pk_...) or a reader credential (asst_rc_...) from pages on the key's allowed origins. See Authentication.

An Assistant API key from Settings > Assistant API: the secret key (asst_sk_...) from servers and tools, or the publishable key (asst_pk_...) or a reader credential (asst_rc_...) from pages on the key's allowed origins. See Authentication.
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An Assistant API key from Settings > Assistant API: the secret key (asst_sk_...) from servers and tools, or the publishable key (asst_pk_...) or a reader credential (asst_rc_...) from pages on the key's allowed origins. See Authentication.

Responses

readyboolean

true when the key can answer now.

problemstring

The error code a question would get, or null.

problem_messagestring

What problem means and what to do, or null.

namestring

The key's name.

integrationstring

The tool chosen in Connected to.

Allowed values:intercomzendeskslackzapiermaken8nserverwebsiteother
callerstring

What the request was sent with: server for the secret key, browser for the publishable key, reader for a reader credential.

Allowed values:serverbrowserreader
accessstring

What the key is set to read: public pages only, or protected pages too.

Allowed values:publicprotected
answers_fromstring

What the key answers from on the site as it is published now. null when that can't be worked out, such as before the site is published.

Allowed values:all_pagespublic_pagesprotected_pages
access_rolesstring[]

The roles the key reads. Secret key only.

allowed_originsstring[]

The origins whose pages can use the key. Secret key only.

requests_per_minutenumber

The key's request limit per minute.

expires_atstring

When the key expires, in ISO 8601 UTC, or null if it never does.