TEteaflask
authed

List publishable keys

The organization's publishable keys, newest first, revoked ones included (check status), each with its full key, allowed origins and the agent it serves. A full page means more may exist.

get/api/v1/serving-identity/keys

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/serving-identity/keys
  • Auth
    none declared

Query parameters

before_created_atstring date-time nullable

With before_id: the last row of the previous page's created_at, to read the next page.

before_idstring uuid nullable

With the sort cursor: the last row of the previous page's id.

limitinteger

The most keys to return.

Response

Successful Response

idstring uuid required

The key's id.

key_prefixstring required

The key's first characters, to recognize it.

keystring nullable required

The full publishable key, safe in page source: it names the organization and agent, and grants nothing on its own. Null only for keys too old to show again.

mode'live' | 'test' required
allowed_originsstring[] required

The only web origins the key answers requests from. Fixed when the key is created.

status'active' | 'revoked' required
revoked_atstring date-time nullable required

When the key was revoked; null while it is active.

last_used_atstring date-time nullable required

When a visitor last started a session with the key; null until the assistant is first opened with it.

created_atstring date-time required

When the key was created.

agent_definition_idstring uuid nullable required

The agent this key serves: conversations started with it run that agent's published version.

Changes

No recorded changes to this operation across all 1 revision of this API.