API reference
Every endpoint of the HQ API, grouped by resource.
Every endpoint below is served under https://api-hq.aiworkforceone.com/v1. The machine-readable contract is at
GET /v1/openapi.json.
Each endpoint shows the permission it needs, its parameters, a request in cURL, JavaScript and
Python, and an example response. Send your key as Authorization: Bearer <key> and pin a dated
version with HQ-Version.
| Resource | Endpoints |
|---|---|
| Essentials | 3 |
| API keys | 3 |
| Organization | 8 |
| AI teams | 10 |
| Cloud Computers | 6 |
| Operations | 2 |
| Sessions | 16 |
| Files | 5 |
| Schedules | 11 |
| Secrets | 13 |
| Variables | 10 |
| Templates | 2 |
| Billing | 3 |
| Audit log | 1 |
| Webhooks | 13 |
Was this page helpful?