Platform API
The Custodian Labs Platform API is the HTTP API that powers Custodian apps and Custodian Squads. It is hosted at:
https://platform.custodianlabs.io/v1
How it fits together
| Layer | What it is |
|---|---|
| Dashboard | Manage your account, plans, API keys, and deployments at dashboard.custodianlabs.io. |
| Platform API | The HTTP endpoints that create and serve Custodian apps and Custodian Squads. |
| Python SDK | A convenient Python client that wraps the Platform API. |
| Chat | The hosted chat interface where people talk to your deployed apps at chat.custodianlabs.io. |
SDK or raw API?
Most developers use the Python SDK to build and deploy Custodians. It handles authentication, retries, session state, and model configuration for you.
Use the Platform API directly when you:
- Write automation in a language other than Python.
- Need to call a deployed Custodian or Custodian Squad over HTTP, for example from a web app backend.
The most common Platform API task is chatting with a deployed app. See Chat.
Authentication
Every request must include your API key in the X-API-Key header. See Platform API Authentication.
What this section covers
- Authentication — send your API key.
- Chat — talk to a deployed Custodian or Custodian Squad.
- Error Responses — understand status codes and error bodies.