PermuteDocs
Go to Permute

Chats · chatsGet

Read a conversation

Returns messages, citations and presentation steps. Native workflow proposals appear as waiting with pendingTask; resolve them through the existing platform task approval API. Hosted Business Action proposals use the chat decisions endpoint.

GET/v1/chats/{chatId}
betauserworkspace

When to use

Poll a conversation for messages, citations and generation status.

For agents

Hosted history requires current app, source and action access, as well as ownership.

Example

typescript
import { PermuteAppClient } from '@permute/sdk/app';

const client = new PermuteAppClient();
const result = await client.chats.get('chat_abcdefghijklmnopqrstuvwx');

Response

json
{
  "data": {
    "id": "chat_abcdefghijklmnopqrstuvwx",
    "status": "completed",
    "error": null,
    "conversation": [
      {
        "role": "assistant",
        "content": "The pipeline contains 11 opportunities."
      }
    ],
    "traceSteps": []
  }
}