Cancel a thread

POST
/v1/threads/{thread_id}/cancel
AuthorizationBearer <token>

Checked by host({authenticate}), which maps the request to a Principal or rejects it.

In: header

Path Parameters

thread_id*string

Lowercase UUID string. Writers MUST generate UUIDv7; readers accept any lowercase UUID, so the version is not an admission rule.

Match^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Query Parameters

branch_id?string

Default: the thread's main branch.

Match^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/threads/string/cancel"
{  "event_id": "string"}
Edit on GitHub