threads

Create a new thread

Changed on
post/threads

Request

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

Request body

modelIdstring uuid

The id of the model

isAnonymousboolean

Enable anonymous mode for this thread

workspaceIdstring uuid

File the new thread under this workspace

Example request

{
  "modelId": "123e4567-e89b-12d3-a456-426614174000",
  "workspaceId": "123e4567-e89b-12d3-a456-426614174000"
}

Response

The thread has been successfully created

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

  • d522c307237bRevision changes
    • info

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

    • info

      response property sources/items/processingError deprecated

  • 5b95a551d820Revision changes
    • info

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

    • info

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