threads

Get a thread by ID

Changed on
get/threads/{id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring uuid required

The UUID of the thread to retrieve

Response

Returns the thread with the specified ID

createdAtstring required

Creation timestamp

updatedAtstring required

Last update timestamp

isAnonymousboolean required

Whether the thread is in anonymous mode (PII redaction enabled)

workspaceIdstring nullable required

The workspace this thread is filed under, if any

idstring required

Unique identifier for the thread

userIdstring required

User ID who owns this thread

permittedModelIdstring required

Permitted model ID

titlestring

Title of the thread

isLongChatboolean required

Whether the thread has exceeded the token threshold for optimal performance

Example response

{
  "createdAt": "2024-01-01T12:00:00.000Z",
  "updatedAt": "2024-01-01T12:30:00.000Z",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "permittedModelId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "Discussion about AI models",
  "messages": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "threadId": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-01T12:00:00.000Z",
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "Hello, how can I help you today?"
        }
      ]
    }
  ],
  "knowledgeBases": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Municipal Zoning Guidelines"
    }
  ],
  "piiMasks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "token": "{{pii:PERSON_NAME_1}}",
      "value": "Max Mustermann"
    }
  ],
  "mcpIntegrations": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "OParl Council Data",
      "logoUrl": "https://marketplace.ayunis.de/logos/oparl.png"
    }
  ]
}

Changes

    • info

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

    • info

      response property sources/items/processingError deprecated

    • info

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

    • info

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