Skip to content

Clients

Talking to the API requires an authenticated client. Each client is issued a token — a prefixed UUID — that you present as a Bearer token on every request. Admin client tokens (adtk_) carry full access, and user-scoped requests use a shorter-lived session token (ustk_), described under Sessions.

The client object

AttributeTypeDescription
iduuidThe unique identifier for the client app.
namestringA name you choose when creating the client.
tokentokenThe client's bearer token, a prefixed UUID. Returned only when the client is created, and never shown again.
revoked_atdatetimeWhen the client was revoked, or null if the client is still active.
created_atdatetimeThe datetime when the client app was created.
json
{
  "id": "4b1d8e2a-7c39-4f60-a5d1-8e2f7c390b64",
  "name": "Amazo Widget client 5",
  "revoked_at": null,
  "created_at": "2026-07-15T18:40:00Z"
}

The API has no clients endpoints, and its discovery document lists none. A client is created for you rather than through the API, so there is nothing here to call — this page describes what a client is, and Authenticating covers using the token it carries.

Shapecaster API Documentation