> For the complete documentation index, see [llms.txt](https://docs.tokenbot.com/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tokenbot.com/home/api-docs/graphql-api/overview.md).

# Overview

The GraphQL API provides full access to the TokenBot platform, including authentication, user management, and admin operations.

## Endpoints

| Environment | URL                                        |
| ----------- | ------------------------------------------ |
| Production  | `https://gql-api.tokenbot.com/graphql`     |
| Development | `https://gql-api-dev.tokenbot.com/graphql` |

## Authentication

The GraphQL API is an Express server (deployed on ECS Fargate) and accepts two auth methods:

1. **JWT bearer token** — pass the `access_token` from the `login` mutation as `Authorization: Bearer <access_token>`.
2. **CLI signed request** — the `x-tb-*` signed-request scheme used by the `tokenbot` CLI.

Public operations (register, login, forgot\_password) require no auth. See [Authentication](/home/api-docs/authentication.md) for full details.

> AWS AppSync + Cognito was retired (PR #148); there is no longer Cognito or `x-api-key` auth.

## Making Requests

```bash
curl -X POST https://gql-api.tokenbot.com/graphql \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "query { me { success data { id email } } }"
  }'
```

## Response Format

Most operations return a typed response with `success`, `data`, and optional `error`:

```json
{
  "data": {
    "me": {
      "success": true,
      "data": {
        "id": "user_123",
        "email": "user@example.com"
      }
    }
  }
}
```

## Real-Time Subscriptions

TokenBot supports GraphQL subscriptions for live updates. See [Subscriptions](/home/api-docs/graphql-api/subscriptions.md) for details and the available channels.

## Documentation

* [Queries](/home/api-docs/graphql-api/queries.md) — All query operations
* [Mutations](/home/api-docs/graphql-api/mutations.md) — All mutation operations
* [Subscriptions](/home/api-docs/graphql-api/subscriptions.md) — Real-time event streams


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.tokenbot.com/home/api-docs/graphql-api/overview.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.