Cancels the active run for the specified agent thread.

POST

https://api.awork.com/api/v1/agents/threads/:threadId/cancel

POST

/api/v1/agents/threads/:threadId/cancel

curl -X POST https://api.awork.com/api/v1/agents/threads/threadId/cancel \
     -H "Authorization: Bearer <token>"

{
  "id": "23e68187-91d6-4f7e-8d31-e3f2c60d7427",
  "createdOn": "2022-03-11T15:33:47.100Z",
  "createdBy": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
  "updatedOn": "2022-03-11T21:15:00.100Z",
  "updatedBy": "3d844c62-7410-4df9-a5b2-78805c0ee260",
  "type": "custom-agent",
  "title": "Weekly client status report",
  "status": "completed",
  "isReadOnly": false,
  "contributors": [
    {
      "id": "70c0f52e-d9af-45e7-b260-a75592a64e43",
      "userId": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
      "accessLevel": "manage"
    }
  ],
  "queue": [
    {
      "id": "23e68187-91d6-4f7e-8d31-e3f2c60d7427",
      "createdOn": "2022-03-11T15:33:47.100Z",
      "createdBy": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
      "updatedOn": "2022-03-11T21:15:00.100Z",
      "updatedBy": "3d844c62-7410-4df9-a5b2-78805c0ee260",
      "threadId": "6cbb219e-839d-4d23-b273-3a78bbd842ae",
      "queueOrder": 1,
      "displayText": "Add client-ready risks and next steps to the status report.",
      "payload": {
        "content": "Summarize this project's progress, risks, and next steps.",
        "attachments": [
          {
            "temporaryFileId": "af6ac9db-479a-49b8-8e1b-994ba79e940f",
            "aworkFileId": "7a5c994a-320a-4850-a7a8-dad86809d3ef"
          }
        ],
        "modelProvider": "openai",
        "modelName": "gpt-5.6-terra",
        "reasoningLevel": "medium",
        "toolAccess": {
          "awork": true,
          "webSearch": true,
          "googleGenAi": false,
          "openAiImageGeneration": false
        },
        "connectorIds": [
          "string"
        ],
        "connectorConnections": [
          {
            "connectorId": "7e376777-7834-4af6-9eb8-da065f568d30",
            "connectionId": "af18602d-c8aa-4f63-a21e-5a7f59b2412c"
          }
        ],
        "skillIds": [
          "string"
        ],
        "answerToInterruptId": "interrupt_01K4CLIENTSTATUS"
      },
      "attachments": [
        {
          "id": "temp_01K4CLIENTBRIEF",
          "name": "acme-client-brief.pdf",
          "mimeType": "application/pdf",
          "sandboxPath": "context/uploads/awork-9ad6397243964b0b9e7d40b852cdebf8-acme-client-brief.pdf",
          "downloadUrl": "/api/v1/agents/threads/6cbb219e-839d-4d23-b273-3a78bbd842ae/artifacts/download?path=client-status-report.pdf"
        }
      ],
      "responsibleUserId": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
      "blockedReason": "interrupted"
    }
  ],
  "agentId": "4d22e163-2b4a-4d47-b51c-5b2217f84f57",
  "agentNameSnapshot": "Client Status Reporter",
  "executionOwnerUserId": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
  "executionTriggeredByUserId": "52c28884-c751-4e0b-820c-9abe8a524a29",
  "executionType": "chat",
  "executionSourceId": "c907b29e-f640-4639-910d-722623fd5b4a",
  "modelProvider": "openai",
  "modelName": "gpt-5.6-terra",
  "parentThreadId": "b5a57e4d-0eec-45b6-b55e-4b70bf0f2a18",
  "projectId": "c907b29e-f640-4639-910d-722623fd5b4a",
  "taskId": "d88ef8fa-e549-4ca6-96d8-83f5be9d37a2",
  "clientId": "61341e18-3e3f-4efb-b471-b781e64f69f7",
  "documentId": "5a442338-8da3-49e9-a702-b45d6f829d43",
  "startedOn": "2026-08-29T08:00:05Z",
  "completedOn": "2026-08-29T08:01:42Z",
  "lastActivityOn": "2026-08-29T08:01:42Z",
  "lastActivityBy": "9ad63972-4396-4b0b-9e7d-40b852cdebf8",
  "failureReason": "The model provider could not complete the run.",
  "lastSequence": 42,
  "latestThreadUpdateSequence": 42,
  "hasUpdate": false,
  "isArchived": false,
  "archivedOn": "2026-08-29T09:30:00Z",
  "isPinned": false,
  "pinnedOrder": 1,
  "isAwaitingAction": false,
  "pendingBatchConfirmation": {
    "confirmationId": "confirm_01K4CLIENTSTATUS",
    "confirmationMessage": "Delete 3 draft tasks from the Acme website project?",
    "affectedItemCount": 3,
    "isDestructive": true,
    "confirmationDetails": {
      "headerMessageEn": "Delete draft tasks",
      "headerMessageDe": "Entwurfsaufgaben löschen",
      "confirmationQuestionEn": "Delete 3 draft tasks from the Acme website project?",
      "confirmationQuestionDe": "3 Entwurfsaufgaben aus dem Acme-Website-Projekt löschen?",
      "confirmButtonTextEn": "Delete",
      "confirmButtonTextDe": "Löschen",
      "cancelButtonTextEn": "Cancel",
      "cancelButtonTextDe": "Abbrechen",
      "isDestructive": true,
      "totalItemCount": 3,
      "actions": [
        {
          "actionDescriptionEn": "Delete draft tasks",
          "actionDescriptionDe": "Entwurfsaufgaben löschen",
          "itemNames": [
            "string"
          ],
          "itemCount": 3,
          "hasMoreItems": false
        }
      ]
    },
    "pendingToolCalls": [
      {
        "id": "call_01K4CLIENTSTATUS",
        "toolName": "code_mode_execute",
        "connectorId": "7e376777-7834-4af6-9eb8-da065f568d30",
        "connectionId": "af18602d-c8aa-4f63-a21e-5a7f59b2412c",
        "arguments": {},
        "response": "{\"status\":\"completed\"}"
      }
    ]
  },
  "pendingUserQuestion": {
    "toolCallId": "call_01K4CLIENTSTATUS",
    "userQuestion": {
      "question": "Should I send the client status report now?",
      "options": [
        "string"
      ],
      "allowCustomText": false,
      "interactionType": "mcp_connection",
      "connectorId": "7e376777-7834-4af6-9eb8-da065f568d30",
      "connectionId": "af18602d-c8aa-4f63-a21e-5a7f59b2412c",
      "connectorName": "Client CRM",
      "connectionAction": "reconnect"
    }
  },
  "usedConnectors": [
    {
      "id": "7e376777-7834-4af6-9eb8-da065f568d30",
      "name": "Client CRM",
      "logoPath": "images/integrations/hubspot_icon.svg"
    }
  ],
  "contextWindowUsageRatio": 0.42,
  "rating": "positive"
}

Cancels the active run in the specified personal-agent or custom-agent conversation and returns the thread. A successful cancellation also pauses dispatch of the next queued message.

Required Permissions

The user must have permission to contribute to the thread.

Cancels the active run in the specified personal-agent or custom-agent conversation and returns the thread. A successful cancellation also pauses dispatch of the next queued message. <Check title="Required Permissions" icon="key">The user must have permission to contribute to the thread.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

threadIdstringRequiredformat: "uuid"

The thread id.

Response

idstringOptionalformat: "uuid"

The id of the entity.

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

typestring or nullOptional

The thread type.

titlestring or nullOptional

The thread title.

statusstring or nullOptional

The thread status.

isReadOnlybooleanOptional

Whether the requester may only read this thread.

contributorslist of objects or nullOptional

The users who explicitly joined this thread.

queuelist of objects or nullOptional

The queued thread messages in dispatch order.

agentIdstring or nullOptionalformat: "uuid"

The agent used for the initial execution.

agentNameSnapshotstring or nullOptional

The immutable initial agent name.

executionOwnerUserIdstring or nullOptionalformat: "uuid"

The user whose permissions applied to the initial execution.

executionTriggeredByUserIdstring or nullOptionalformat: "uuid"

The user who triggered the initial execution.

executionTypestring or nullOptional

The initial execution type.

executionSourceIdstring or nullOptionalformat: "uuid"

The entity that caused the initial execution.

modelProviderstring or nullOptional

The model provider.

modelNamestring or nullOptional

The provider model name.

parentThreadIdstring or nullOptionalformat: "uuid"

The parent thread id.

projectIdstring or nullOptionalformat: "uuid"

The associated project id.

taskIdstring or nullOptionalformat: "uuid"

The associated task id.

clientIdstring or nullOptionalformat: "uuid"

The associated client id.

documentIdstring or nullOptionalformat: "uuid"

The associated document id.

startedOnstring or nullOptionalformat: "date-time"

When execution started.

completedOnstring or nullOptionalformat: "date-time"

When execution completed.

lastActivityOnstring or nullOptionalformat: "date-time"

The latest activity timestamp.

lastActivityBystring or nullOptionalformat: "uuid"

The user responsible for the latest user-message activity.

failureReasonstring or nullOptional

The failure reason.

lastSequencelongOptional

The latest persisted event sequence.

latestThreadUpdateSequencelongOptional

The latest event sequence that creates a thread update.

hasUpdatebooleanOptional

Whether the requester has an unseen update.

isArchivedbooleanOptional

Whether the requester archived the thread.

archivedOnstring or nullOptionalformat: "date-time"

When the requester archived the thread.

isPinnedbooleanOptional

Whether the requester pinned the thread.

pinnedOrderdouble or nullOptional

The requester's pinned order.

isAwaitingActionbooleanOptional

Whether the thread awaits user action.

pendingBatchConfirmationobjectOptional

Represents a pending batch confirmation for an agent thread.

pendingUserQuestionobjectOptional

Represents a pending user question for an agent thread.

usedConnectorslist of objects or nullOptional

Connectors used successfully in this thread on detail responses.

contextWindowUsageRatiodouble or nullOptional

The context-window usage ratio on detail responses.

ratingstring or nullOptional

The personal-thread rating on detail responses.

Errors

404

Not Found Error