Sign in
assistants

Changed on
get/v1/assistants/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token
    • API key in header Authorization

Query parameters

hosting'all' | 'local' | 'platform'

Filter assistants by hosting mode. 'platform' (default) returns only platform-managed assistants. 'local' returns only self-hosted local assistants. 'all' returns both.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

Headers

Vellum-Organization-Idstring uuid

Required if using Cookie-based or X-Session-Token authentication methods.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes

  • ad08cc82e970Revision changes
    • ○

      added the required property // to the response with the status

  • ba57f0a2366fRevision changes
    • ○

      added the required property // to the response with the status