🚀 Simplify your work by integrating Haufe Copilot via API
Threads

Create a run

Invokes the assistant on a thread and returns the response. Accepts optional tool configuration. The thread must contain at least one user message. An assistant message requesting tool calls must be followed by the corresponding tool messages. For every tool message, a corresponding assistant message with the same tool_call_id must exist.

POST/v1/threads/{thread_id}/run

Authorization

APIKeyHeader
api-key<token>

In: header

Path Parameters

thread_id*|null

Request Body

application/json

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/run" \  -H "Content-Type: application/json" \  -d '{}'
{
  "content": "Während der Probezeit beträgt die Kündigungsfrist gemäß § 622 Abs. 3 BGB zwei Wochen. Diese Frist gilt für beide Seiten.",
  "created_at": "2025-03-15T09:13:02.654321Z",
  "id": "5e6f7081-9012-def0-1234-556677889900",
  "meta_data": {
    "intent": "Kündigungsfrist Probezeit",
    "legal_advice": false,
    "type": "53aa66b7-b874-407f-967c-3a959c919d62"
  },
  "role": "assistant",
  "sources": [
    {
      "content": "§ 622 Abs. 3 BGB: Während einer vereinbarten Probezeit, längstens für die Dauer von sechs Monaten, kann das Arbeitsverhältnis mit einer Frist von zwei Wochen gekündigt werden.",
      "meta_data": {
        "document_title": "Bürgerliches Gesetzbuch (BGB)",
        "section": "§ 622 Abs. 3"
      }
    }
  ],
  "thread_id": "1a2b3c4d-5678-9abc-def0-112233445566"
}

{
  "error_code": "content_filter_error",
  "detail": "Could not parse response content as the request was rejected by the content filter."
}

{
  "error_code": "unauthorized",
  "detail": "Missing or invalid API key"
}

{
  "error_code": "assistant_not_found",
  "detail": "Assistant not found"
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

{
  "message": "Rate limit exceeded!"
}

{
  "error_code": "internal_server_error",
  "detail": "Internal Server Error"
}