> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryopencomputer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference scope

> Understand the customer API and integration-specific behavior.

The reference documents Athena's hosted customer API: agents, calls, campaigns, model configurations, telephony configuration, tools, knowledge documents, website sessions, and reporting. The request fields are checked against the running API's OpenAPI schema. Authentication metadata is clarified from the actual route dependencies because the runtime schema does not describe every custom API-key check.

Administrative metrics, platform-superuser operations, provider callback handlers, and internal voice-worker operations are outside this customer reference. An organization administrator is different from a platform superuser. Retry Review's staff-only star-management and golden-case export routes are not customer API operations.

## Stable integration choices

Use public call-trigger endpoints to initiate phone calls from your backend. Dashboard management endpoints serve resource configuration; their availability still depends on account permissions and feature settings.

Use exact field names from the schema. Some integration identifiers and headers retain legacy names for compatibility, even though the hosted product is Athena.

## Validation versus runtime

A documented schema describes accepted fields. It does not guarantee that a configured external provider is reachable or that a call will complete. Follow the [run verification stages](https://docs.tryopencomputer.com/guides/runs.md) when checking an integration end to end.

The reference is read-only. Run examples from your backend with your own API key and synthetic test resources. Calls, tool tests, campaign actions, and text sessions perform real work.

## Feature prerequisites

| Feature | Availability |
| - | - |
| Catalog template duplication | Currently unavailable due to a routing conflict (`422`). Use Agent Builder or Blank Canvas. |
| Retry Review | Must be enabled for the deployment. Disabled routes return `404`. See [Retry Review](https://docs.tryopencomputer.com/guides/retries.md). |
| Daily priced usage | Requires organization pricing. An unpriced organization receives `400`; it does not imply a missing usage record. |
| Credit checkout | The compatibility purchase-URL endpoint is unavailable on the verified Athena deployment and returns `404`. |
| Inference service keys | Depend on a separately configured integration and differ from Athena API keys. Service-key reactivation returns `501`. |
| Public embed TURN credentials | Require an enabled relay service. The credential endpoint returns `503` when TURN is not configured; session initialization and TURN credential generation are separate operations. |
| Knowledge vector search | Requires an embeddings configuration. Full Document processing is a separate path and does not establish vector-search availability. |
| Recording playback | Requires an available artifact and configured signing. A run can legitimately have no recording or transcript URL. |
| Provider operations | Require that provider's configuration and account permissions. Catalog visibility alone does not establish live connectivity. |

Use the guides for each feature's setup and lifecycle, including [Athena capabilities](https://docs.tryopencomputer.com/guides/capabilities.md), [Models](https://docs.tryopencomputer.com/guides/models.md), [Tools and knowledge](https://docs.tryopencomputer.com/guides/tools.md), and [Website embedding](https://docs.tryopencomputer.com/guides/website.md).

## Setup guides and verification scope

The [feature setup map](https://docs.tryopencomputer.com/guides/setup.md) covers the customer dashboard and all seven available tool categories, including Athena-specific retries, caller memory, menu/hold handling, speech caching, and agent handovers. Configuration steps are checked against the corresponding dashboard fields and backend behavior. This does not mean each provider combination has passed a live end-to-end test.

Controlled phone and browser conversations, text sessions, HTTP-tool and post-call webhook delivery, resource lifecycles, and selected retry/campaign contracts were checked during the documentation audit. Vector search with an embedding provider, external Langfuse/BigQuery delivery without customer destination credentials, and every carrier/runtime transfer combination are not certified by those checks. Configure and verify those integrations in your own account before rollout.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.