Cancel a response
curl --request POST \
--url https://guidinghand.ai/v1/responses/{response_id}/cancel \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://guidinghand.ai/v1/responses/{response_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://guidinghand.ai/v1/responses/{response_id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"object": "response",
"id": "resp_…",
"conversation_id": "<string>",
"status": "in_progress",
"error": "<string>",
"output": [
{
"object": "conversation_item",
"seq": 123,
"response_id": "<string>",
"at": "2023-11-07T05:31:56Z",
"type": "user_message",
"text": "<string>",
"speaker": "caller",
"queued": true,
"view": {
"version": 1,
"sections": [
{
"blocks": [
{
"type": "text"
}
],
"title": "<string>",
"badge": {
"text": "<string>",
"tone": "neutral"
}
}
]
},
"call_id": "<string>",
"name": "<string>",
"arguments": {},
"label": "<string>",
"output": "<string>",
"task": {
"task_id": "<string>",
"kind": "browser",
"status": "queued",
"result": "<string>",
"goal": "<string>",
"computer": "<string>",
"plan": [
"<string>"
],
"plan_step": 2
},
"files": [
{
"id": "<string>",
"filename": "<string>",
"content_type": "<string>",
"kind": "image",
"bytes": 123
}
],
"error": true,
"surface_id": "<string>",
"title": "<string>",
"fields": [
{}
],
"a2ui": [
{}
],
"answer": {},
"approval": {
"approval_id": "apr_…",
"scope": "run",
"action": "<string>",
"source": "guardrail",
"site": "<string>",
"app": "<string>",
"category": "<string>",
"risk": "<string>",
"task_id": "<string>",
"procedure_id": "<string>",
"by": "anyone",
"who": "<string>",
"note": "<string>",
"covers": [
"purchase"
],
"surface_id": "<string>",
"a2ui": [
{}
],
"decision": {
"decision": "approve",
"note": "<string>",
"by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
},
"question": {
"question_id": "qst_…",
"task_id": "<string>",
"question": "<string>",
"options": [
"<string>"
],
"surface_id": "<string>",
"a2ui": [
{}
],
"answer": {
"text": "<string>",
"by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
}
}
],
"usage": {
"input_tokens": 123,
"cached_tokens": 123,
"cache_write_tokens": 123,
"output_tokens": 123,
"reasoning_tokens": 123,
"tasks": [
{
"task_id": "<string>",
"cost_cents": 123
}
],
"code_runs": 123
},
"created_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"queued_message": {
"object": "conversation_item",
"seq": 123,
"response_id": "<string>",
"at": "2023-11-07T05:31:56Z",
"type": "user_message",
"text": "<string>",
"speaker": "caller",
"queued": true,
"view": {
"version": 1,
"sections": [
{
"blocks": [
{
"type": "text"
}
],
"title": "<string>",
"badge": {
"text": "<string>",
"tone": "neutral"
}
}
]
},
"call_id": "<string>",
"name": "<string>",
"arguments": {},
"label": "<string>",
"output": "<string>",
"task": {
"task_id": "<string>",
"kind": "browser",
"status": "queued",
"result": "<string>",
"goal": "<string>",
"computer": "<string>",
"plan": [
"<string>"
],
"plan_step": 2
},
"files": [
{
"id": "<string>",
"filename": "<string>",
"content_type": "<string>",
"kind": "image",
"bytes": 123
}
],
"error": true,
"surface_id": "<string>",
"title": "<string>",
"fields": [
{}
],
"a2ui": [
{}
],
"answer": {},
"approval": {
"approval_id": "apr_…",
"scope": "run",
"action": "<string>",
"source": "guardrail",
"site": "<string>",
"app": "<string>",
"category": "<string>",
"risk": "<string>",
"task_id": "<string>",
"procedure_id": "<string>",
"by": "anyone",
"who": "<string>",
"note": "<string>",
"covers": [
"purchase"
],
"surface_id": "<string>",
"a2ui": [
{}
],
"decision": {
"decision": "approve",
"note": "<string>",
"by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
},
"question": {
"question_id": "qst_…",
"task_id": "<string>",
"question": "<string>",
"options": [
"<string>"
],
"surface_id": "<string>",
"a2ui": [
{}
],
"answer": {
"text": "<string>",
"by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
}
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"test_case_ids": [
"<string>"
],
"decided_by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"conversation_id": "<string>",
"agent_id": "<string>",
"approval_id": "<string>",
"question_id": "<string>"
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"test_case_ids": [
"<string>"
],
"decided_by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"conversation_id": "<string>",
"agent_id": "<string>",
"approval_id": "<string>",
"question_id": "<string>"
}
}Responses
Cancel a response
Stops the turn and any browser task it is running. What it wrote so far stays, and the conversation goes on from there: the agent’s next turn reads the message, its files, what it had done, and that it was stopped.
POST
/
v1
/
responses
/
{response_id}
/
cancel
Cancel a response
curl --request POST \
--url https://guidinghand.ai/v1/responses/{response_id}/cancel \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://guidinghand.ai/v1/responses/{response_id}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://guidinghand.ai/v1/responses/{response_id}/cancel"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"object": "response",
"id": "resp_…",
"conversation_id": "<string>",
"status": "in_progress",
"error": "<string>",
"output": [
{
"object": "conversation_item",
"seq": 123,
"response_id": "<string>",
"at": "2023-11-07T05:31:56Z",
"type": "user_message",
"text": "<string>",
"speaker": "caller",
"queued": true,
"view": {
"version": 1,
"sections": [
{
"blocks": [
{
"type": "text"
}
],
"title": "<string>",
"badge": {
"text": "<string>",
"tone": "neutral"
}
}
]
},
"call_id": "<string>",
"name": "<string>",
"arguments": {},
"label": "<string>",
"output": "<string>",
"task": {
"task_id": "<string>",
"kind": "browser",
"status": "queued",
"result": "<string>",
"goal": "<string>",
"computer": "<string>",
"plan": [
"<string>"
],
"plan_step": 2
},
"files": [
{
"id": "<string>",
"filename": "<string>",
"content_type": "<string>",
"kind": "image",
"bytes": 123
}
],
"error": true,
"surface_id": "<string>",
"title": "<string>",
"fields": [
{}
],
"a2ui": [
{}
],
"answer": {},
"approval": {
"approval_id": "apr_…",
"scope": "run",
"action": "<string>",
"source": "guardrail",
"site": "<string>",
"app": "<string>",
"category": "<string>",
"risk": "<string>",
"task_id": "<string>",
"procedure_id": "<string>",
"by": "anyone",
"who": "<string>",
"note": "<string>",
"covers": [
"purchase"
],
"surface_id": "<string>",
"a2ui": [
{}
],
"decision": {
"decision": "approve",
"note": "<string>",
"by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
},
"question": {
"question_id": "qst_…",
"task_id": "<string>",
"question": "<string>",
"options": [
"<string>"
],
"surface_id": "<string>",
"a2ui": [
{}
],
"answer": {
"text": "<string>",
"by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
}
}
],
"usage": {
"input_tokens": 123,
"cached_tokens": 123,
"cache_write_tokens": 123,
"output_tokens": 123,
"reasoning_tokens": 123,
"tasks": [
{
"task_id": "<string>",
"cost_cents": 123
}
],
"code_runs": 123
},
"created_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"queued_message": {
"object": "conversation_item",
"seq": 123,
"response_id": "<string>",
"at": "2023-11-07T05:31:56Z",
"type": "user_message",
"text": "<string>",
"speaker": "caller",
"queued": true,
"view": {
"version": 1,
"sections": [
{
"blocks": [
{
"type": "text"
}
],
"title": "<string>",
"badge": {
"text": "<string>",
"tone": "neutral"
}
}
]
},
"call_id": "<string>",
"name": "<string>",
"arguments": {},
"label": "<string>",
"output": "<string>",
"task": {
"task_id": "<string>",
"kind": "browser",
"status": "queued",
"result": "<string>",
"goal": "<string>",
"computer": "<string>",
"plan": [
"<string>"
],
"plan_step": 2
},
"files": [
{
"id": "<string>",
"filename": "<string>",
"content_type": "<string>",
"kind": "image",
"bytes": 123
}
],
"error": true,
"surface_id": "<string>",
"title": "<string>",
"fields": [
{}
],
"a2ui": [
{}
],
"answer": {},
"approval": {
"approval_id": "apr_…",
"scope": "run",
"action": "<string>",
"source": "guardrail",
"site": "<string>",
"app": "<string>",
"category": "<string>",
"risk": "<string>",
"task_id": "<string>",
"procedure_id": "<string>",
"by": "anyone",
"who": "<string>",
"note": "<string>",
"covers": [
"purchase"
],
"surface_id": "<string>",
"a2ui": [
{}
],
"decision": {
"decision": "approve",
"note": "<string>",
"by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
},
"question": {
"question_id": "qst_…",
"task_id": "<string>",
"question": "<string>",
"options": [
"<string>"
],
"surface_id": "<string>",
"a2ui": [
{}
],
"answer": {
"text": "<string>",
"by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"at": "2023-11-07T05:31:56Z"
}
}
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"test_case_ids": [
"<string>"
],
"decided_by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"conversation_id": "<string>",
"agent_id": "<string>",
"approval_id": "<string>",
"question_id": "<string>"
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"test_case_ids": [
"<string>"
],
"decided_by": {
"type": "person",
"email": "<string>",
"key_id": "<string>"
},
"conversation_id": "<string>",
"agent_id": "<string>",
"approval_id": "<string>",
"question_id": "<string>"
}
}Authorizations
An org API key (gh_live_…) from Settings → API keys in the console.
Path Parameters
The response’s id.
Response
The response.
Example:
"resp_…"
requires_action: paused on a request in output (an approval or question item) until someone decides it. Send the decision to POST /v1/agents/{agent_id}/responses (approval, answer, or an A2UI action on its surface), and this same response carries on.
Available options:
in_progress, requires_action, completed, failed, cancelled This turn’s items.
Show child attributes
Show child attributes
What the reply used, set when it ends (empty until then). Its tokens are paid from the balance at the model’s price, rounded up to a whole cent per reply. The browser and desktop tasks it started are charged as tasks.
Show child attributes
Show child attributes
Only when your message was queued (202): its item.
Show child attributes
Show child attributes