Create agent session cancel

POST/workspaces/{organizationId}/agent/sessions/{sessionId}/cancel

Path parameters

organizationIdstringrequired

sessionIdstringrequired

Responses

200Session canceled

idstringrequired

organizationIdstringrequired

issueIdstringrequired

agentIdstringrequired

providerstringrequired

actorIdstringrequired

actorTypestringrequired

Allowed:useragent

statusstringrequired

Allowed:createdrunningwaitingcompletedfailedcanceled

resultstring | nullrequired

urlstring | nullrequired

providerSessionIdstring | nullrequired

prUrlstring | nullrequired

prStatestring | nullrequired

branchstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

lastProgressAtstring | null

lastStateHashstring | null

activitiesobject[]

Show properties

Array of object

idstringrequired

sessionIdstringrequired

actorIdstring | nullrequired

typestringrequired

Allowed:thoughtresponseerrorelicitationactionstatusartifact

messagestringrequired

payloadany | null

parentIdstring | nullrequired

startedAtstring | nullrequired

endedAtstring | nullrequired

durationMsnumber | nullrequired

createdAtstringrequired

404Session not found

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*sessionIdpath*

Request

curl -X POST "/workspaces/string/agent/sessions/string/cancel"

const response = await fetch("/workspaces/string/agent/sessions/string/cancel", {
  method: "POST"
});

import requests

response = requests.post(
    "/workspaces/string/agent/sessions/string/cancel",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "issueId": "string",
  "agentId": "string",
  "provider": "string",
  "actorId": "string",
  "actorType": "user",
  "status": "created",
  "result": "string",
  "url": "string",
  "providerSessionId": "string",
  "prUrl": "string",
  "prState": "string",
  "branch": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "lastProgressAt": "string",
  "lastStateHash": "string",
  "activities": [
    {
      "id": "string",
      "sessionId": "string",
      "actorId": "string",
      "type": "thought",
      "message": "string",
      "payload": null,
      "parentId": "string",
      "startedAt": "string",
      "endedAt": "string",
      "durationMs": 0,
      "createdAt": "string"
    }
  ]
}