# API reference

Every endpoint of the HQ API, grouped by resource.



{/* Generated from openapi/openapi.yaml by `npm run gen:api-docs`. Do not edit by hand. */}

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](/docs/api/reference/essentials/)           | 3         |
| [API keys](/docs/api/reference/api-keys/)               | 3         |
| [Organization](/docs/api/reference/organization/)       | 8         |
| [AI teams](/docs/api/reference/teams/)                  | 10        |
| [Cloud Computers](/docs/api/reference/cloud-computers/) | 6         |
| [Operations](/docs/api/reference/operations/)           | 2         |
| [Sessions](/docs/api/reference/sessions/)               | 16        |
| [Files](/docs/api/reference/files/)                     | 5         |
| [Schedules](/docs/api/reference/schedules/)             | 11        |
| [Secrets](/docs/api/reference/secrets/)                 | 13        |
| [Variables](/docs/api/reference/variables/)             | 10        |
| [Templates](/docs/api/reference/templates/)             | 2         |
| [Billing](/docs/api/reference/billing/)                 | 3         |
| [Audit log](/docs/api/reference/audit/)                 | 1         |
| [Webhooks](/docs/api/reference/webhooks/)               | 13        |
