staqlydocs
REST APIAPI referenceWorkspace

One of the caller's assistant chats, with its messages and the change waiting for a decision

One of the caller's assistant chats, with its messages and the change waiting for a decision

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

GET
/v1/assistant/chats/{id}

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

id*string

Response Body

OK

application/json
  1. response

A conversation with the assistant, kept for the person who had it; lists leave out messages and pending

id*string
title*string

The first thing the person asked

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
messages?array<>
pending?

The tool call waiting for Allow or Deny

Example Request
curl -X GET 'https://staqly.example.com/v1/assistant/chats/string'
Example Response
{  "id": "string",  "title": "string",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "messages": [    {      "role": "user",      "content": "string",      "tool_calls": [        {          "id": "string",          "name": "string",          "arguments": "string"        }      ],      "tool_call_id": "string",      "attachments": [        {          "media_id": "string",          "name": "string",          "mime_type": "string"        }      ]    }  ],  "pending": {    "id": "string",    "name": "string",    "arguments": "string"  }}