---
title: "ProxyAI API documentation"
description: Discover ProxyAI's REST API, OpenAPI schemas, public product catalogue, cursor pagination and structured errors.
canonical: https://www.proxyai.app/docs/api
last-updated: 2026-10-19
---

> For the complete documentation index, see [llms.txt](https://www.proxyai.app/llms.txt). Request public content pages with `Accept: text/markdown`.

# ProxyAI API documentation

The ProxyAI REST API provides a public product catalogue and separately authorized checkout operations. Use the [MCP connector](https://www.proxyai.app/docs/mcp) for customer tickets and supported Agent Tasks.

## API discovery and OpenAPI

Read `/api` for protocol discovery and `/openapi.json` for the deployed OpenAPI contract. The contract always describes the public catalogue. Purchase operations appear when their required features and payment configuration are enabled. Check each operation's security requirements before calling it.

## Public product catalogue

`GET /api/v1/products` lists active products visible in the public catalogue. It does not require an account, expose customer data or make a purchase.

```sh
curl 'https://www.proxyai.app/api/v1/products?limit=10'
```

The JSON response contains `currency`, `items`, `has_more` and `next_cursor`. Each item has `id`, `name`, `description`, `price` and `creditValue`. Prices are decimal strings in USD. A credit value is a decimal string or null; the description may also be null.

## Cursor pagination

The optional `limit` parameter accepts 1–100 and defaults to 50. Products are ordered by ID. Pass a response's `next_cursor` as the next request's `cursor`, or follow its `Link: rel=next` header. Stop when `next_cursor` is null. Do not construct or guess cursors.

## Rate limits and errors

The catalogue allows 60 requests per minute per IP. Inspect `RateLimit` and `RateLimit-Policy`; respect `Retry-After` after HTTP 429.

Catalogue errors use `application/problem+json` with `type`, `title`, `status`, `code`, `message` and `hint`. HTTP 400 reports invalid query parameters, 429 reports a rate limit, and 503 reports an unavailable catalogue. Retrying a catalogue read does not create a purchase.

## Authentication and purchases

Read [ProxyAI authentication documentation](https://www.proxyai.app/docs/authentication) before using account or payment operations. MCP read/write scopes do not authorize purchases. Follow the deployed OpenAPI contract and each checkout protocol's authorization requirements.