Skip to main content
This API Reference section is a work in progress. We’re actively enhancing endpoint descriptions, parameter documentation, and interactive examples throughout early January 2026. For more detailed descriptions and examples, see the legacy API reference.
The Freeplay REST API enables you to integrate observability and prompt management into your AI applications.

OpenAPI Specification

Access the raw OpenAPI 3.0 specification for use with code generators, API clients, or LLM tools.
Using a coding agent? Point it to docs.freeplay.ai/llms.txt for LLM-optimized documentation.

​
Base URL

Your API root is your Freeplay instance URL plus /api/v2/: 
https://app.freeplay.ai/api/v2
For private deployments, use your custom domain (e.g., https://acme.freeplay.ai/api/v2).

​
Authentication

Freeplay authenticates requests using API keys, which you can manage at https://app.freeplay.ai/settings/api-access. Include your API key in the Authorization header: 
Authorization: Bearer {freeplay_api_key}

​
Error Handling

Freeplay uses standard HTTP status codes:
CodeMeaning
200Success
400Bad request — check your request parameters
401Unauthorized — invalid or missing API key
500Server error — safe to retry
Errors in the 400-499 range are client errors and won’t resolve with retries. For 500 errors, retry up to 3 times with at least a 5-second delay between attempts.