Answer a question or approval (moved to the conversation)

curl --request POST \
  --url https://guidinghand.ai/v1/tasks/{task_id}/respond \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question_id": "<string>",
  "answer": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({question_id: '<string>', answer: '<string>'})
};

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

import requests

url = "https://guidinghand.ai/v1/tasks/{task_id}/respond"

payload = {
    "question_id": "<string>",
    "answer": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

Tasks

Answer a question or approval (moved to the conversation)

deprecated

A task’s questions and approvals are decided in its conversation: POST /v1/conversations//decisions (or POST /v1/agents//responses, which also streams the reply that carries on). This route decides nothing: it answers 409 with code: "decide_in_conversation", the task’s conversation_id and agent_id (null for a task run without an agent), and the request’s approval_id or question_id (the one you sent, else the one the task waits on).

POST

tasks

{task_id}

respond

Answer a question or approval (moved to the conversation)

curl --request POST \
  --url https://guidinghand.ai/v1/tasks/{task_id}/respond \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question_id": "<string>",
  "answer": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({question_id: '<string>', answer: '<string>'})
};

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

import requests

url = "https://guidinghand.ai/v1/tasks/{task_id}/respond"

payload = {
    "question_id": "<string>",
    "answer": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

task_id

string

required

The task’s id.

Body

application/json

Answer a question
Decide an approval

question_id

string

required

answer

string

required

Maximum string length: 4000

Response

Missing or invalid API key.

error

object

required

Show child attributes