> ## Documentation Index
> Fetch the complete documentation index at: https://developers.workchats.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Reference overview

> How to read the endpoint reference

The pages under this section are generated from the API's OpenAPI spec.
Each one has the request shape, every response, every error the endpoint
can return, and a **Try it** playground.

## Base URL

This site has a version per environment (the switcher is in the top nav):

| Version | Environment | URL |
| - | - | - |
| Production | Production | `https://public-api.workchats.com` |
| Staging (sandbox) | Staging sandbox | `https://public-api.staging.workchats.com` |
| Dev | Dev | `https://public-api.dev.workchats.com` |

<Note>
  The **Try it** playground on each version's pages is wired to that
  version's own environment — the Production version calls production, the
  Staging (sandbox) version calls staging, and so on. Paste in a matching
  token: a `wc_bot_test_…` token from your [sandbox](/getting-started/sandbox)
  install works on the Staging (sandbox) version, not on Production.
</Note>

## Authentication

```
Authorization: Bearer wc_bot_live_…
```

`POST /oauth/token` and `POST /oauth/revoke` authenticate differently, with
your App's `client_id` / `client_secret` — see [OAuth install](/guides/oauth-install).

## Every response

Success:

```json theme={null}
{ "ok": true, "…": "…" }
```

Error:

```json theme={null}
{ "ok": false, "error": { "code": "…", "message": "…" }, "request_id": "…" }
```

Every response also carries an `X-Request-Id` header, matching
`request_id` on an error.

## Related reference pages

<CardGroup cols={2}>
  <Card title="Scopes" href="/reference/scopes" icon="key" />

  <Card title="Error codes" href="/reference/error-codes" icon="triangle-exclamation" />

  <Card title="Block types" href="/reference/block-types" icon="table-cells" />

  <Card title="Objects" href="/reference/objects" icon="brackets-curly" />

  <Card title="Callbacks" href="/reference/callbacks" icon="webhook" />
</CardGroup>