Resume dashboard companion after approval

POST/v1/companion/resume

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

decisionCompanionResumeDecisionrequired

Show properties

approvedbooleanrequired

disapprove_reasonstring

edited_argumentsobject

interrupt_idstringrequired

run_idstringrequired

Responses

200OK

interrupt_idstring

messagestringrequired

modelstringrequired

next_toolstring

partsCompanionPart[] | nullrequired

Show properties

Array of CompanionPart

argsobject

resultany

textstring

tool_call_idstring

tool_namestring

typestringrequired

plan_cursorinteger<int64>

plan_doneboolean

plan_idstring

plan_next_stepobject

providerstringrequired

requires_actionCompanionRequiresAction

Show properties

argumentsobject

interrupt_idstring

raw_requestobject

tool_namestring

typestring

run_idstring

statusstring

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/companion/resume" \
  -H "Content-Type: application/json" \
  -d '{
  "decision": {
    "approved": true,
    "disapprove_reason": "string",
    "edited_arguments": {}
  },
  "interrupt_id": "string",
  "run_id": "string"
}'

const response = await fetch("/v1/companion/resume", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "decision": {
    "approved": true,
    "disapprove_reason": "string",
    "edited_arguments": {}
  },
  "interrupt_id": "string",
  "run_id": "string"
})
});

import requests

response = requests.post(
    "/v1/companion/resume",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "decision": {
    "approved": True,
    "disapprove_reason": "string",
    "edited_arguments": {}
  },
  "interrupt_id": "string",
  "run_id": "string"
},
)

Response

{
  "interrupt_id": "string",
  "message": "string",
  "model": "string",
  "next_tool": "string",
  "parts": [
    {
      "args": {},
      "result": "string",
      "text": "string",
      "tool_call_id": "string",
      "tool_name": "string",
      "type": "string"
    }
  ],
  "plan_cursor": 0,
  "plan_done": true,
  "plan_id": "string",
  "plan_next_step": {},
  "provider": "string",
  "requires_action": {
    "arguments": {},
    "interrupt_id": "string",
    "raw_request": {},
    "tool_name": "string",
    "type": "string"
  },
  "run_id": "string",
  "status": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}