API reference

Every Management and Delivery API operation, with its parameters, schemas and examples. Try any of them against your TaleArt API.

Before you try

1. Set the API URL below to your TaleArt API. It starts as the local API, http://localhost:3333.
2. Choose Authorize and paste an API token (tat_…) for the Management API, or a zone key (tak_…) or the project's site key (tas_…) for the Delivery API.
3. Open an operation, choose Try it out, then Execute.

From a terminal or a script, the taleart command-line tool calls these operations for you; an AI agent can drive it with the TaleArt skill: see AI agents.

Operations

Loading the reference… It needs JavaScript; without it, read the OpenAPI document at api-reference/openapi.json.

Accessibility

The reference is Swagger UI 5.33.1. The docs restyle it for contrast in the light and dark themes, enlarge its copy buttons, name its dialog and close button, keep the keyboard inside the Authorize dialog and return it to the button that opened it, and let wide tables scroll on narrow screens. What the docs cannot change from outside:

• A response from Execute is not announced to screen readers. Move on to the Server response heading below the button to read it.
• The lock button on each operation is named “authorization button locked” or “unlocked”; it opens the same Authorize dialog.

Every operation is also in the OpenAPI document, api-reference/openapi.json, which any OpenAPI tool reads.