Skip to content
UltimateTeam.ai Docs

Close Thread

POST
/api/v1/team-chat/threads/{thread_id}/close
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/team-chat/threads/example/close \
  --header 'X-API-Key: <X-API-Key>'

Close a conversation thread.

Args: thread_id: The thread UUID string. user: The authenticated user context. svc: The conversation service (injected).

Returns: The closed thread.

Raises: HTTPException: 404 if thread not found.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
thread_id
required
Thread Id
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
ThreadResponse

Response schema for a persisted conversation thread.

Attributes: id: Unique thread identifier. tenant_id: Owning tenant UUID. context_id: Groups related A2A messages. title: Human-readable thread title. status: Thread lifecycle state. participant_roles: List of agent role strings. workflow_run_id: Optional FK to workflow_runs.id. metadata: Extensible metadata. created_at: When the thread was created. updated_at: When the thread was last updated. message_count: Number of messages in the thread.

object
context_id
required
Context Id
string
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
message_count
Message Count
integer
0
metadata
required
Any of:
object
key
additional properties
any
participant_roles
required
Participant Roles
Array<string>
status
required
Status
string
tenant_id
required
Tenant Id
string format: uuid
title
required
Any of:
string
updated_at
required
Updated At
string format: date-time
workflow_run_id
required
Any of:
string format: uuid
Example
{
  "message_count": 0
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}