> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.voodoo.center/api-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.voodoo.center/_mcp/server.

# API Reference


## API Docs

- API Reference [Order status update](https://docs.voodoo.center/api-reference/api-reference/order-status-webhook.md)
- API Reference > Authentication [Exchange an API key for an access token](https://docs.voodoo.center/api-reference/api-reference/authentication/exchange-api-key.md)
- API Reference > Account [Get your account](https://docs.voodoo.center/api-reference/api-reference/account/get-account.md)
- API Reference > Orders [Place an order](https://docs.voodoo.center/api-reference/api-reference/orders/create-order.md)
- API Reference > Orders [Get an order](https://docs.voodoo.center/api-reference/api-reference/orders/get-order.md)
- API Reference > Orders [Get an order by your reference](https://docs.voodoo.center/api-reference/api-reference/orders/get-order-by-merchant-order-id.md)
- API Reference > Orders [Submit the customer's confirmation code](https://docs.voodoo.center/api-reference/api-reference/orders/submit-order-client-code.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.voodoo.center/openapi.json)
- [OpenAPI YAML](https://docs.voodoo.center/openapi.yaml)


> **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.voodoo.center/api-reference/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.voodoo.center/_mcp/server.

# Overview

This section is the full, interactive reference for the Voodoo Center API,
generated from our OpenAPI specification. Every endpoint lists its parameters,
request and response schemas, example payloads, and an **API Explorer** you can
use to send real requests.

## Endpoints

The programmatic API has five endpoints, plus the token-exchange endpoint used
to authenticate:

| Method | Path                                      | Purpose                                                                            |
| ------ | ----------------------------------------- | ---------------------------------------------------------------------------------- |
| `POST` | `/v1/auth/token/client`                   | Exchange an `ak_` API key for a Bearer token.                                      |
| `GET`  | `/v1/account/me`                          | Read your account — balance, subscription status and client id.                    |
| `POST` | `/v1/orders`                              | Place an order (charges balance, returns `pending`).                               |
| `GET`  | `/v1/orders/{id}`                         | Look up one of your orders.                                                        |
| `GET`  | `/v1/orders/merchant/{merchant_order_id}` | Look up one of your orders by the `merchant_order_id` you placed it with.          |
| `POST` | `/v1/orders/{id}/client-code`             | Submit the customer's confirmation code for an order paused on `need_client_code`. |

The reference also documents the outbound **order-status webhook** Voodoo Center
sends to your URL when an order settles. See the [Webhooks guide](/webhooks) for
verification details.

## Authenticating the API Explorer — enter only your API key

The Explorer handles authentication for you. You provide **only your `ak_` API
key**; it obtains the access token automatically.

#### Enter your API key

Open the authorization panel and paste your `ak_` API key. That's the only
credential you supply — there is no JWT to paste.

#### Run any endpoint

When you send a request, the Explorer first calls
`POST /v1/auth/token/client` with your key, then uses the returned
`access_token` as `Authorization: Bearer <token>` on the call. The
token-exchange endpoint itself is public, so it needs no authorization.

#### Keep going

Access tokens last 15 minutes; the Explorer transparently re-exchanges your key
as needed, so you can keep trying endpoints without re-entering anything.

> **Note**
>
> The Explorer sends live requests to `https://api.voodoo.center` — the same calls
> you can make with cURL or from your own backend.