Retrieve the Playbook
curl --request GET \
--url https://api-us.hihobbes.com/api/v1/playbook \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/playbook"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-us.hihobbes.com/api/v1/playbook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"staging": {
"version": 123,
"visibleSections": {},
"companyPromptBody": "<string>"
},
"production": {
"version": 123,
"visibleSections": {},
"companyPromptBody": "<string>"
},
"sectionCatalog": [
{
"key": "<string>",
"title": "<string>",
"kind": "structured",
"order": 123,
"description": "<string>",
"present": true,
"category": "<string>"
}
],
"sectionsEtag": "<string>",
"isLegacyStructure": true,
"links": {
"staging": {
"url": "<string>",
"availabilityReason": "<string>"
},
"production": {
"url": "<string>",
"availabilityReason": "<string>"
}
}
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": "No agent version exists for the key's organization."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}Playbook
Retrieve the Playbook
Return structured staging and production Playbooks, versions, and agent links.
GET
/
api
/
v1
/
playbook
Retrieve the Playbook
curl --request GET \
--url https://api-us.hihobbes.com/api/v1/playbook \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-us.hihobbes.com/api/v1/playbook"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-us.hihobbes.com/api/v1/playbook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"staging": {
"version": 123,
"visibleSections": {},
"companyPromptBody": "<string>"
},
"production": {
"version": 123,
"visibleSections": {},
"companyPromptBody": "<string>"
},
"sectionCatalog": [
{
"key": "<string>",
"title": "<string>",
"kind": "structured",
"order": 123,
"description": "<string>",
"present": true,
"category": "<string>"
}
],
"sectionsEtag": "<string>",
"isLegacyStructure": true,
"links": {
"staging": {
"url": "<string>",
"availabilityReason": "<string>"
},
"production": {
"url": "<string>",
"availabilityReason": "<string>"
}
}
}{
"detail": "API key required or invalid."
}{
"detail": "API key does not include the required scope."
}{
"detail": "No agent version exists for the key's organization."
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "Rate limit or organization quota exceeded."
}Requires
playbook:read.
Use sectionsEtag for concurrency-safe previews. The response includes the
section catalog, exact staging and production versions, and links for testing
each agent. Legacy Playbooks are returned as read-only.Authorizations
bearerapiKeyHeader
Hobbes API key with the hb_live_ prefix.
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes