Accept a proposed change

curl --request POST \
  --url https://guidinghand.ai/v1/escalations/{escalation_id}/accept \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://guidinghand.ai/v1/escalations/{escalation_id}/accept', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://guidinghand.ai/v1/escalations/{escalation_id}/accept"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "object": "escalation",
  "id": "<string>",
  "agent_id": "<string>",
  "kind": "approval",
  "status": "open",
  "source": "live",
  "summary": "<string>",
  "count": 123,
  "procedure": {
    "id": "<string>",
    "title": "<string>",
    "revision": 123
  },
  "failed_at": "<string>",
  "proposal": {
    "base_revision": 123,
    "body": "<string>"
  },
  "owner": "<string>",
  "details": "<string>",
  "tasks": [
    "<string>"
  ],
  "conversation_id": "<string>",
  "request_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_seen_at": "2023-11-07T05:31:56Z",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolution": "decided",
  "resolved_by": {
    "type": "<string>",
    "email": "<string>",
    "key_id": "<string>"
  },
  "resolved_revision": 123
}

{
  "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>"
  }
}

{
  "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>"
  }
}

POST

escalations

{escalation_id}

Accept a proposed change

curl --request POST \
  --url https://guidinghand.ai/v1/escalations/{escalation_id}/accept \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://guidinghand.ai/v1/escalations/{escalation_id}/accept', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://guidinghand.ai/v1/escalations/{escalation_id}/accept"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

{
  "object": "escalation",
  "id": "<string>",
  "agent_id": "<string>",
  "kind": "approval",
  "status": "open",
  "source": "live",
  "summary": "<string>",
  "count": 123,
  "procedure": {
    "id": "<string>",
    "title": "<string>",
    "revision": 123
  },
  "failed_at": "<string>",
  "proposal": {
    "base_revision": 123,
    "body": "<string>"
  },
  "owner": "<string>",
  "details": "<string>",
  "tasks": [
    "<string>"
  ],
  "conversation_id": "<string>",
  "request_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "last_seen_at": "2023-11-07T05:31:56Z",
  "resolved_at": "2023-11-07T05:31:56Z",
  "resolution": "decided",
  "resolved_by": {
    "type": "<string>",
    "email": "<string>",
    "key_id": "<string>"
  },
  "resolved_revision": 123
}

{
  "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>"
  }
}

{
  "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

Authorization

string

header

required

An org API key (gh_live_…) from Settings → API keys in the console.

Path Parameters

escalation_id

string

required

The escalation’s id, like esc_….

Response

The escalation, resolved.

object

string

Allowed value: "escalation"

string

agent_id

string

kind

enum<string>

Available options:

approval,

question,

procedure_failed,

procedure_change,

handoff

status

enum<string>

Available options:

open,

resolved

source

enum<string>

eval: raised only by eval runs so far (no webhooks).

Available options:

live,

eval

summary

string

What happened, in a sentence or two.

count

integer

How many runs raised it (a procedure escalation adds repeats to the open one).

procedure

object | null

The procedure, as the run got it.

Show child attributes

failed_at

string | null

The step it failed at or left.

proposal

object | null

For procedure_change: the procedure body rewritten to what worked, from base_revision.

Show child attributes

owner

string | null

For handoff: who the agent said should take it.

details

string | null

For handoff: what the agent knew when it handed the request over (what was asked, identifiers, lookups, the open point).

tasks

string[]

The runs that raised it, newest first (up to 20).

conversation_id

string | null

request_id

string | null

For an approval or question: its approval_id or question_id.

created_at

string<date-time>

last_seen_at

string<date-time>

resolved_at

string<date-time> | null

resolution

enum<string> | null

fixed: the procedure got a new revision (resolved_revision); deleted: it was deleted. handled: the team marked a hand-off done.

Available options:

decided,

answered,

timed_out,

moved_on,

fixed,

deleted,

accepted,

rejected,

dismissed,

handled,

null

resolved_by

object | null

Show child attributes

resolved_revision

integer | null