Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Interact with Peachdesk programmatically via the REST API
https://your-peachdesk-instance/api/v1
https://api.peachdeskai.com/api/v1.
v1. The version is included in the URL path.
X-API-Key header on every request:
X-API-Key: bibha_your_api_key
/admin/*, /sa/* and /superuser/*, and the pk_live_тАж service key for
/api/v1/mps/*. See Authentication.
Content-Type: application/json header.
curl -X POST https://your-peachdesk-instance/api/v1/workflow/create/definition \
-H "Content-Type: application/json" \
-H "X-API-Key: bibha_your_api_key" \
-d '{"name": "My Agent", "workflow_definition": {}}'
{
"detail": "Error message describing what went wrong"
}
{
"detail": [
{
"loc": ["body", "name"],
"msg": "field required",
"type": "value_error.missing"
}
]
}
curl https://your-peachdesk-instance/api/v1/health
{
"status": "ok",
"version": "1.0.0",
"backend_api_endpoint": "https://your-peachdesk-instance",
"deployment_mode": "oss",
"auth_provider": "local"
}