Get a version
curl --request GET \
--url https://guidinghand.ai/v1/agents/{agent_id}/versions/{version} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://guidinghand.ai/v1/agents/{agent_id}/versions/{version}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://guidinghand.ai/v1/agents/{agent_id}/versions/{version}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "agent_version",
"agent_id": "billing",
"version": 3,
"note": "Order lookup",
"published_at": "2023-11-07T05:31:56Z",
"published_by": {
"type": "user",
"email": "jane@acme.com"
},
"agent": {
"object": "agent",
"agent_id": "billing",
"name": "Billing help",
"instructions": "<string>",
"model": "claude-sonnet-5-5",
"effort": "low",
"greeting": "<string>",
"display_name": "Acme Support",
"narration": true,
"customer_answers": true,
"customer_approvals": true,
"guardrails": {
"mode": "supervised",
"confirm": [
"purchase",
"send",
"delete",
"install",
"security",
"terms"
],
"block": [],
"apps": {
"allow": [],
"block": []
},
"sites": {
"allow": [],
"block": []
},
"safety_checks": "ask",
"scope": "",
"screen_check": false,
"max_steps": 150,
"max_minutes": null,
"approval_timeout_minutes": null
},
"tools": {
"files": {
"enabled": true,
"access": "read_write"
},
"http": []
},
"is_default": true,
"invite_url_template": "https://guidinghand.ai/acme/billing/{code}",
"version": 3,
"has_draft": true,
"created_by": {
"type": "user",
"email": "jane@acme.com"
},
"updated_by": {
"type": "user",
"email": "jane@acme.com"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}Agents
Get a version
One published version, with the agent as it was then.
GET
/
v1
/
agents
/
{agent_id}
/
versions
/
{version}
Get a version
curl --request GET \
--url https://guidinghand.ai/v1/agents/{agent_id}/versions/{version} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://guidinghand.ai/v1/agents/{agent_id}/versions/{version}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://guidinghand.ai/v1/agents/{agent_id}/versions/{version}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"object": "agent_version",
"agent_id": "billing",
"version": 3,
"note": "Order lookup",
"published_at": "2023-11-07T05:31:56Z",
"published_by": {
"type": "user",
"email": "jane@acme.com"
},
"agent": {
"object": "agent",
"agent_id": "billing",
"name": "Billing help",
"instructions": "<string>",
"model": "claude-sonnet-5-5",
"effort": "low",
"greeting": "<string>",
"display_name": "Acme Support",
"narration": true,
"customer_answers": true,
"customer_approvals": true,
"guardrails": {
"mode": "supervised",
"confirm": [
"purchase",
"send",
"delete",
"install",
"security",
"terms"
],
"block": [],
"apps": {
"allow": [],
"block": []
},
"sites": {
"allow": [],
"block": []
},
"safety_checks": "ask",
"scope": "",
"screen_check": false,
"max_steps": 150,
"max_minutes": null,
"approval_timeout_minutes": null
},
"tools": {
"files": {
"enabled": true,
"access": "read_write"
},
"http": []
},
"is_default": true,
"invite_url_template": "https://guidinghand.ai/acme/billing/{code}",
"version": 3,
"has_draft": true,
"created_by": {
"type": "user",
"email": "jane@acme.com"
},
"updated_by": {
"type": "user",
"email": "jane@acme.com"
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}{
"error": {
"type": "invalid_request",
"message": "<string>",
"code": "<string>",
"answered_by": "customer",
"test_case_ids": [
"<string>"
]
}
}Authorizations
An org API key (gh_live_…) from Settings → API keys in the console.
Path Parameters
The agent’s id, e.g. billing or default.
Required range:
x >= 1Response
OK
Example:
"billing"
Required range:
x >= 1Example:
3
What changed, as given when it was published, or empty.
Example:
"Order lookup"
Who published it. Null for an agent’s first version when it was made before versions were kept.
- Person
- API key
Show child attributes
Show child attributes
The agent as of that version (version is this one, and has_draft is false).
Show child attributes
Show child attributes