Cancel a delegate task | Runtype Documentation

{
  "accepted": true,
  "task": {
    "apiKeyId": "key_01jh1234567890abcdef000001",
    "clientName": "runtype-sdk-python",
    "clientVersion": "1.4.2",
    "completedAt": null,
    "createdAt": "2025-01-15T10:22:00Z",
    "error": null,
    "id": "dlg_01jh0000000000000000000000",
    "instruction": "Analyze the latest sales report and generate a summary with key insights",
    "lastEventSeq": 14,
    "modelRoundCount": 3,
    "organizationId": "org_01jh9876543210abcdef000001",
    "question": null,
    "result": {
      "links": [
        {
          "label": "Sales Report Q4 2024",
          "url": "https://app.runtype.com/reports/sales-q4-2024"
        }
      ],
      "modelRoundCount": 3,
      "summary": "Task was cancelled after 3 model rounds. Partial analysis completed before cancellation.",
      "toolCallCount": 7,
      "touchedEntities": [
        {
          "action": "read",
          "id": "report_01jh1111111111111111111111",
          "kind": "Report",
          "name": "Sales Report Q4 2024"
        }
      ],
      "totalCost": 0.0342,
      "warnings": [
        "Task was cancelled before completion; results may be incomplete."
      ]
    },
    "startedAt": "2025-01-15T10:22:05Z",
    "status": "cancelled",
    "summary": "Partial sales analysis completed before cancellation was requested.",
    "toolCallCount": 7,
    "totalCost": 0.0342,
    "touchedEntities": [
      {
        "action": "read",
        "id": "report_01jh1111111111111111111111",
        "kind": "Report",
        "name": "Sales Report Q4 2024"
      }
    ],
    "updatedAt": "2025-01-15T10:23:47Z",
    "userId": "usr_01jh5555555555555555555555"
  }
}

Stop the task after its current tool round. API keys need DELEGATE_TASKS:WRITE.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

The task id (dlg_…).

Response

Cancellation requested

acceptedboolean

taskobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

503

Service Unavailable Error