For the complete documentation index, see llms.txt. This page is also available as Markdown.

Advocate REST API

The Advocate API is organized around REST. The API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. It uses built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients. JSON will be returned in all responses from the API, including errors.

To make the Advocate API as explorable as possible, accounts have test-mode API keys as well as live-mode API keys. Use test-mode keys during development and live-mode keys in production.

Last updated