# Athena

- [Build conversations with Athena](https://docs.tryopencomputer.com/index.md): Create voice agents in your dashboard and connect them to your applications.
- [Athena capabilities](https://docs.tryopencomputer.com/guides/capabilities.md): A guide to voice settings, traffic controls, retries, and run review.
- [Your first agent](https://docs.tryopencomputer.com/guides/first-agent.md): Create, test, and publish an Athena agent safely.
- [Agents, drafts, and publishing](https://docs.tryopencomputer.com/guides/agents.md): Work with workflow drafts, published versions, and API identifiers.
- [Providers, models, and voices](https://docs.tryopencomputer.com/guides/models.md): Connect providers and reuse model configurations across agents.
- [Connect telephony](https://docs.tryopencomputer.com/guides/telephony.md): Set up caller IDs, trunks, and inbound agent routing.
- [Tools and knowledge](https://docs.tryopencomputer.com/guides/tools.md): Give an agent tested actions and processed reference documents.
- [Run campaigns](https://docs.tryopencomputer.com/guides/campaigns.md): Prepare contact batches, schedules, traffic splits, and retry rules.
- [Calls, runs, and results](https://docs.tryopencomputer.com/guides/runs.md): Follow an execution from initiation through reports and media.
- [Retry Review](https://docs.tryopencomputer.com/guides/retries.md): Understand Athena's retry decisions, holds, and rerun paths.
- [Context and variables](https://docs.tryopencomputer.com/guides/context.md): Pass call data into a workflow and use it in prompts and tools.
- [Embed an agent on your website](https://docs.tryopencomputer.com/guides/website.md): Configure a public embed token or use the authenticated text-chat API.
- [API quickstart](https://docs.tryopencomputer.com/guides/api.md): Authenticate backend requests to the hosted Athena API.
- [Text chat sessions and streaming](https://docs.tryopencomputer.com/guides/text-chat.md): Create authenticated workflow sessions, stream turns, and recover safely.
- [API reference scope](https://docs.tryopencomputer.com/guides/coverage.md): Understand the customer API and integration-specific behavior.
- [Trigger a phone call](https://docs.tryopencomputer.com/guides/calls.md): Start a published or draft call and follow the result.
- [Webhooks and call events](https://docs.tryopencomputer.com/guides/webhooks.md): Connect conversation results to your own service.
- [Troubleshooting](https://docs.tryopencomputer.com/guides/troubleshooting.md): Find the failing stage before changing your integration.
- [Validate Workflow](https://docs.tryopencomputer.com/api-reference/workflow/validate-workflow.md): Validate the saved workflow graph and return its validation issues. Saving a definition does not prove its model, tools, or telephony connection can execute. See [Agents](/guides/agents).
- [Create Workflow](https://docs.tryopencomputer.com/api-reference/workflow/create-workflow.md): Create a workflow from nodes and edges. Use the numeric returned id for management requests; fetch its workflow_uuid when calling the public workflow trigger. See [Agents](/guides/agents).
- [Create Workflow From Template](https://docs.tryopencomputer.com/api-reference/workflow/create-workflow-from-template.md): Create an agent from an available template. Template availability depends on the configured template service; use definition-based creation for a definition you already own.
- [Get Workflow Count](https://docs.tryopencomputer.com/api-reference/workflow/get-workflow-count.md): Count workflows visible in the selected organization using the requested status and folder filters.
- [Get Workflows](https://docs.tryopencomputer.com/api-reference/workflow/get-workflows.md): List workflows in the selected organization. Use the supported pagination, folder, and search parameters to narrow the result.
- [Get Workflow](https://docs.tryopencomputer.com/api-reference/workflow/get-workflow.md): Get an accessible workflow and its active definition: the draft when one exists, otherwise its published definition. A public published trigger still uses the released definition.
- [Get Workflow Version Summaries](https://docs.tryopencomputer.com/api-reference/workflow/get-workflow-version-summaries.md): Return lightweight version information for an agent. Use the versions endpoint when you need full definition snapshots.
- [Get Workflow Versions](https://docs.tryopencomputer.com/api-reference/workflow/get-workflow-versions.md): Read saved definition versions using the supported status and version filters. Version identifiers are different from workflow and run identifiers.
- [Update Workflow Version Metadata](https://docs.tryopencomputer.com/api-reference/workflow/update-workflow-version-metadata.md): Edit the name or change description of a published or archived version. Draft metadata is not eligible and returns 404; supply draft release notes during publishing.
- [Publish Workflow](https://docs.tryopencomputer.com/api-reference/workflow/publish-workflow.md): Publish the current draft with optional release notes. A successful publish makes the released definition available to published call triggers. Publishing without a draft returns 400.
- [Create Workflow Draft](https://docs.tryopencomputer.com/api-reference/workflow/create-workflow-draft.md): Create or obtain the editable draft for the workflow. Draft changes remain separate from the published definition until you publish them.
- [Get Workflows Summary](https://docs.tryopencomputer.com/api-reference/workflow/get-workflows-summary.md): Return workflow summaries for the selected organization, including the lightweight fields used to select an agent.
- [Update Workflow Status](https://docs.tryopencomputer.com/api-reference/workflow/update-workflow-status.md): Update the workflow's status. Archive a disposable agent when it should no longer appear among active agents; archiving is not hard deletion.
- [Move Workflow To Folder](https://docs.tryopencomputer.com/api-reference/workflow/move-workflow-to-folder.md): Move a workflow to an organization-owned folder. Use null for folder_id to move it to Uncategorized.
- [Update Workflow](https://docs.tryopencomputer.com/api-reference/workflow/update-workflow.md): Update the workflow name, definition, context variables, or configuration. Definition and configuration changes are saved as a draft; publish the intended version before using published triggers.
- [Duplicate Workflow Endpoint](https://docs.tryopencomputer.com/api-reference/workflow/duplicate-workflow-endpoint.md): Create a new workflow by copying the source agent's definition and associated configuration. The duplicate receives its own identifiers.
- [Get Workflow Runs](https://docs.tryopencomputer.com/api-reference/workflow/get-workflow-runs.md): Read executions for one workflow using the supported filters and pagination. Keep the returned run id to retrieve its final state and activity.
- [Create Workflow Run](https://docs.tryopencomputer.com/api-reference/workflow/create-workflow-run.md): Create a workflow execution for a supported dashboard mode. This is not a public phone-call trigger. The browser_voice_transport response determines which browser media connection to establish.
- [Create Livekit Session](https://docs.tryopencomputer.com/api-reference/workflow/create-livekit-session.md): Obtain LiveKit connection information for an authorized browser voice run. This starts real model work and reserves capacity; successful connection setup alone does not verify microphone or two-way audio.
- [Get Workflow Run](https://docs.tryopencomputer.com/api-reference/workflow/get-workflow-run.md): Read a run's state, usage, context, and available artifacts. Treat returned public artifact URLs and access tokens as capabilities: anyone possessing them may be able to read the artifact.
- [Download Workflow Report](https://docs.tryopencomputer.com/api-reference/workflow/download-workflow-report.md): Download the workflow's run report as CSV. Check the response Content-Type before parsing it; the successful response is a file rather than a JSON object.
- [Get Workflow Templates](https://docs.tryopencomputer.com/api-reference/workflow/get-workflow-templates.md): Read templates exposed by the configured template service. An unavailable template service does not imply an existing agent is unavailable.
- [Duplicate Workflow Template](https://docs.tryopencomputer.com/api-reference/workflow/duplicate-workflow-template.md): Copy a template into the selected organization. Use the template identifier required by this request, not an existing workflow UUID.
- [Get a presigned URL to upload a custom ambient noise audio file](https://docs.tryopencomputer.com/api-reference/workflow/get-a-presigned-url-to-upload-a-custom-ambient-noise-audio-file.md): Request an upload URL for an organization-owned workflow. Upload audio to the returned URL separately; requesting the URL does not upload or enable the file.
- [Create Text Chat Session](https://docs.tryopencomputer.com/api-reference/workflow/create-text-chat-session.md): Create a text session and execute its initial turn. Supply a request_id UUID to recover a creation response lost in transit. This request can consume model capacity. See [Text chat](/guides/text-chat).
- [Get Text Chat Session](https://docs.tryopencomputer.com/api-reference/workflow/get-text-chat-session.md): Read the current text transcript, checkpoint, and revision. Use the latest revision for subsequent optimistic-concurrency requests.
- [Recover Text Chat Session](https://docs.tryopencomputer.com/api-reference/workflow/recover-text-chat-session.md): Find a session by the client-supplied request_id used during creation. A null result means that creation is not currently visible; it is not permission to create duplicate work blindly.
- [Append Text Chat Message](https://docs.tryopencomputer.com/api-reference/workflow/append-text-chat-message.md): Append text to an active session and execute the next agent turn. Use expected_revision to detect stale clients; resynchronize after 409 rather than replaying blindly.
- [End Text Chat Session](https://docs.tryopencomputer.com/api-reference/workflow/end-text-chat-session.md): Complete the text session. Messages cannot continue after completion. Supply the latest expected_revision when using optimistic concurrency.
- [Rewind Text Chat Session](https://docs.tryopencomputer.com/api-reference/workflow/rewind-text-chat-session.md): Restore the session to a supported turn cursor. Use the current expected_revision to avoid overwriting a newer conversation state.
- [Stream Text Chat Session](https://docs.tryopencomputer.com/api-reference/workflow/stream-text-chat-session.md): Create a text session through a server-sent event response. Read event frames through completion and handle terminal errors; the initial HTTP response does not prove a completed turn.
- [Stream Text Chat Message](https://docs.tryopencomputer.com/api-reference/workflow/stream-text-chat-message.md): Send a message and receive server-sent events for the resulting turn. Apply revision checks and process the terminal session or error event. See [Text chat](/guides/text-chat).
- [Get Embed Token](https://docs.tryopencomputer.com/api-reference/workflow/get-embed-token.md): Read the workflow's embed configuration and generated script. A workflow without an active configuration can return null.
- [Create Or Update Embed Token](https://docs.tryopencomputer.com/api-reference/workflow/create-or-update-embed-token.md): Create or update the workflow's single active embed configuration, allowed domains, limits, expiry, and settings. Use the returned embed_script without renaming its legacy wire attributes.
- [Deactivate Embed Token](https://docs.tryopencomputer.com/api-reference/workflow/deactivate-embed-token.md): Deactivate the workflow's embed token to prevent new widget access. Do not confuse token revocation with ending an already created chat session.
- [Get Workflow Run Activity](https://docs.tryopencomputer.com/api-reference/workflow/get-workflow-run-activity.md): Read the server-sanitized activity timeline for this workflow's run. The timeline explains execution events and is distinct from the conversation transcript.
- [Get Api Keys](https://docs.tryopencomputer.com/api-reference/user/get-api-keys.md): List metadata for organization API keys, optionally including archived keys. This does not return complete existing keys.
- [Create Api Key](https://docs.tryopencomputer.com/api-reference/user/create-api-key.md): Create an organization API key. The full api_key is returned at creation; keep it in backend secret storage and never place it in a website widget.
- [Archive Api Key](https://docs.tryopencomputer.com/api-reference/user/archive-api-key.md): Deactivate an organization-owned API key. Requests using an archived key no longer authenticate.
- [Reactivate Api Key](https://docs.tryopencomputer.com/api-reference/user/reactivate-api-key.md): Reactivate an archived organization-owned API key. This differs from inference service keys, whose reactivation is unsupported.
- [Get Service Keys](https://docs.tryopencomputer.com/api-reference/user/get-service-keys.md): Compatibility endpoint for a separately configured inference service. Service keys are different from Athena customer API keys and require that external integration.
- [Create Service Key](https://docs.tryopencomputer.com/api-reference/user/create-service-key.md): Compatibility endpoint for the configured inference service. Use customer API keys for Athena management and call-trigger requests; this does not create that kind of key.
- [Archive Service Key](https://docs.tryopencomputer.com/api-reference/user/archive-service-key.md): Deactivate a service key through the configured external integration. Availability and errors depend on that service.
- [Reactivate Service Key](https://docs.tryopencomputer.com/api-reference/user/reactivate-service-key.md): This compatibility endpoint returns 501. An archived inference service key cannot be reactivated; create a new key through its supported integration. Athena customer API keys have a separate reactivation endpoint.
- [Get Campaign Traffic Stats](https://docs.tryopencomputer.com/api-reference/campaign/get-campaign-traffic-stats.md): Inspect execution statistics for the campaign's assigned workflow variants. A traffic allocation describes intended distribution rather than a guarantee that every variant has completed calls.
- [Create Campaign](https://docs.tryopencomputer.com/api-reference/campaign/create-campaign.md): Create a campaign from a previously uploaded CSV and either a workflow_id or traffic_split. Creation validates source columns, routing, and capacity. Starting the campaign is a separate operation that can dial real numbers. See [Campaigns](/guides/campaigns).
- [Get Campaigns](https://docs.tryopencomputer.com/api-reference/campaign/get-campaigns.md): List campaigns in the selected organization with progress, configuration, and warnings.
- [Get Campaign](https://docs.tryopencomputer.com/api-reference/campaign/get-campaign.md): Read an organization-owned campaign's state, scheduling, retry configuration, routing, and progress.
- [Update Campaign](https://docs.tryopencomputer.com/api-reference/campaign/update-campaign.md): Change supported campaign settings. Use the schema's exact schedule slots and traffic_split fields. The organization concurrency ceiling is enforced independently of caller-ID rotation.
- [Start Campaign](https://docs.tryopencomputer.com/api-reference/campaign/start-campaign.md): Start the campaign's calling work after validating organization telephony and quota. This can place real calls. A successful response does not mean all contacts have answered.
- [Pause Campaign](https://docs.tryopencomputer.com/api-reference/campaign/pause-campaign.md): Pause further campaign dispatch. Already active calls may continue; inspect active calls and campaign progress before assuming calling has stopped.
- [Get Campaign Runs](https://docs.tryopencomputer.com/api-reference/campaign/get-campaign-runs.md): Read executions associated with this campaign using its supported paging parameters.
- [Redial Campaign](https://docs.tryopencomputer.com/api-reference/campaign/redial-campaign.md): Create the redial batch for the selected voicemail, no-answer, or busy outcomes. At least one retry reason must remain selected. Treat this operation as call-affecting. Campaign redial differs from retry-review reruns.
- [Resume Campaign](https://docs.tryopencomputer.com/api-reference/campaign/resume-campaign.md): Resume a paused campaign after telephony and quota checks. Resuming can place real calls.
- [Get Campaign Progress](https://docs.tryopencomputer.com/api-reference/campaign/get-campaign-progress.md): Read current campaign progress without starting or resuming calls.
- [Get Campaign Source Download Url](https://docs.tryopencomputer.com/api-reference/campaign/get-campaign-source-download-url.md): Obtain a temporary URL for the campaign's uploaded CSV. The URL grants access to contact data; keep it private.
- [Download Campaign Report](https://docs.tryopencomputer.com/api-reference/campaign/download-campaign-report.md): Download the campaign's result report as CSV. The successful response is a file, not a JSON object.
- [List Credentials](https://docs.tryopencomputer.com/api-reference/credentials/list-credentials.md): List organization credential metadata. Secret credential_data is not returned.
- [Create Credential](https://docs.tryopencomputer.com/api-reference/credentials/create-credential.md): Store a credential for supported tool authentication. Use the fields required by credential_type; responses omit credential_data. Do not substitute this resource for an Athena customer API key.
- [Get Credential](https://docs.tryopencomputer.com/api-reference/credentials/get-credential.md): Read an accessible credential's metadata without retrieving its stored secret value.
- [Update Credential](https://docs.tryopencomputer.com/api-reference/credentials/update-credential.md): Update an accessible credential. Keep secret values in credential_data rather than prompts or public website code.
- [Delete Credential](https://docs.tryopencomputer.com/api-reference/credentials/delete-credential.md): Deactivate the credential using the product's soft-delete behavior. This does not certify erasure of historical records.
- [List Tools](https://docs.tryopencomputer.com/api-reference/tools/list-tools.md): List tools accessible to the selected organization, with supported filtering and pagination.
- [Create Tool](https://docs.tryopencomputer.com/api-reference/tools/create-tool.md): Create a reusable HTTP API or MCP tool. The returned identifier is tool_uuid. For an HTTP action use definition.type=http_api and definition.config. See [Tools](/guides/tools).
- [Get Tool](https://docs.tryopencomputer.com/api-reference/tools/get-tool.md): Read an accessible tool by tool_uuid, not its numeric database identifier.
- [Update Tool](https://docs.tryopencomputer.com/api-reference/tools/update-tool.md): Update the tool's supported metadata or definition. Test the resulting downstream request against a service you control before using it in an agent.
- [Delete Tool](https://docs.tryopencomputer.com/api-reference/tools/delete-tool.md): Archive the tool. The record remains available to archive-aware product paths and can be restored with unarchive.
- [Refresh Mcp Tools](https://docs.tryopencomputer.com/api-reference/tools/refresh-mcp-tools.md): Connect to the configured MCP service and refresh its discovered tools. This performs a real external request and requires an MCP tool configuration.
- [Test Tool](https://docs.tryopencomputer.com/api-reference/tools/test-tool.md): Execute the configured tool using llm_params and preset_params. This performs real downstream work. Inspect status_code and data in the result; HTTP 200 from this wrapper alone does not prove the downstream request succeeded.
- [Unarchive Tool](https://docs.tryopencomputer.com/api-reference/tools/unarchive-tool.md): Reactivate a previously archived tool in the selected organization.
- [Get Telephony Providers Metadata](https://docs.tryopencomputer.com/api-reference/organizations/get-telephony-providers-metadata.md): Read provider capabilities and setup fields used by the Telephony dashboard. A listed provider still needs a valid, ready configuration for your account.
- [Get Telephony Config Warnings](https://docs.tryopencomputer.com/api-reference/organizations/get-telephony-config-warnings.md): Read organization-level warning counts for incomplete provider verification settings. Check the individual configuration's setup checklist for actionable steps.
- [Get Preferences](https://docs.tryopencomputer.com/api-reference/organizations/get-preferences.md): Read the selected organization's supported call-event and behavior preferences.
- [Save Preferences](https://docs.tryopencomputer.com/api-reference/organizations/save-preferences.md): Update organization-level preferences using the exact request schema. These settings affect the organization, so avoid using an existing account's preferences as disposable test data.
- [List Telephony Configurations](https://docs.tryopencomputer.com/api-reference/organizations/list-telephony-configurations.md): Read configuration metadata, outbound readiness, default selection, and inactive state. This list does not reveal complete provider credentials.
- [Create Telephony Configuration](https://docs.tryopencomputer.com/api-reference/organizations/create-telephony-configuration.md): Create an organization telephony configuration using the provider-discriminated config body. Some providers provision remote resources on save. Manage phone numbers using their dedicated endpoints.
- [Get Telephony Configuration By Id](https://docs.tryopencomputer.com/api-reference/organizations/get-telephony-configuration-by-id.md): Read a configuration's masked credentials, provider capabilities, setup checklist, and trunks. Saving a configuration does not establish outbound readiness.
- [Update Telephony Configuration](https://docs.tryopencomputer.com/api-reference/organizations/update-telephony-configuration.md): Update a configuration's name or provider-specific settings. The provider cannot be changed in place. Follow masked-secret preservation behavior and avoid sending a different provider's fields.
- [Delete Telephony Configuration](https://docs.tryopencomputer.com/api-reference/organizations/delete-telephony-configuration.md): Delete a configuration only when it is no longer referenced. In-use configurations can return 409. Provider cleanup behavior depends on the configuration type.
- [Set Default Outbound](https://docs.tryopencomputer.com/api-reference/organizations/set-default-outbound.md): Set the organization default for outbound configuration resolution. Inbound-only providers cannot be selected. This changes future calls that omit an explicit configuration.
- [Reactivate Telephony Configuration](https://docs.tryopencomputer.com/api-reference/organizations/reactivate-telephony-configuration.md): Clear the configuration's inactive state after fixing its connectivity problem. Workers can pick it up again; reactivation itself does not prove a successful provider connection.
- [List Telephony Trunks](https://docs.tryopencomputer.com/api-reference/organizations/list-telephony-trunks.md): List trunks for an accessible telephony configuration. Trunk support depends on its provider.
- [Create Telephony Trunk](https://docs.tryopencomputer.com/api-reference/organizations/create-telephony-trunk.md): Create a provider-supported carrier path. settings follows that provider's trunk schema. Some providers are provisioned remotely before the local record is created.
- [Update Telephony Trunk](https://docs.tryopencomputer.com/api-reference/organizations/update-telephony-trunk.md): Update trunk name, enabled state, or provider-specific settings. Omitted fields keep their stored values; provider changes may be applied remotely.
- [Delete Telephony Trunk](https://docs.tryopencomputer.com/api-reference/organizations/delete-telephony-trunk.md): Delete an unused trunk. If phone numbers still reference it, move those numbers first; the API returns 409 rather than silently detaching them.
- [List Phone Numbers](https://docs.tryopencomputer.com/api-reference/organizations/list-phone-numbers.md): List phone numbers and caller-ID metadata under this telephony configuration.
- [Create Phone Number](https://docs.tryopencomputer.com/api-reference/organizations/create-phone-number.md): Add a number or supported address to the configuration. Address normalization is performed server-side. Any inbound workflow and trunk references must belong to this organization and configuration.
- [Get Phone Number](https://docs.tryopencomputer.com/api-reference/organizations/get-phone-number.md): Read one phone-number record within its configuration, including routing and caller-ID settings.
- [Update Phone Number](https://docs.tryopencomputer.com/api-reference/organizations/update-phone-number.md): Update a phone number's supported fields. Inbound routing changes may synchronize with the provider; inspect any provider_sync result.
- [Delete Phone Number](https://docs.tryopencomputer.com/api-reference/organizations/delete-phone-number.md): Remove the phone-number record and synchronize inbound detachment where supported. Inspect provider synchronization results instead of assuming provider state changed.
- [Set Default Caller Id](https://docs.tryopencomputer.com/api-reference/organizations/set-default-caller-id.md): Select this number as the configuration's default outbound caller. This changes calls that rely on default caller-ID resolution.
- [Get Organization Concurrent Calls](https://docs.tryopencomputer.com/api-reference/organizations/get-organization-concurrent-calls.md): Read occupied concurrent call slots across workers, including dialing and ringing reservations. Expired slots are excluded. This is capacity occupancy, not a count of answered conversations.
- [Get Current Period Usage](https://docs.tryopencomputer.com/api-reference/organizations/get-current-period-usage.md): Read current organization usage and quota information where configured. Usage counters are distinct from evidence that payment collection is enabled.
- [Get Billing Credits](https://docs.tryopencomputer.com/api-reference/organizations/get-billing-credits.md): Read credit information exposed for this deployment and account. A valid response does not mean online checkout or usage-based charges are configured.
- [Create Mps Credit Purchase Url](https://docs.tryopencomputer.com/api-reference/organizations/create-mps-credit-purchase-url.md): Checkout URL compatibility endpoint. Credit purchases are unavailable on the currently verified Athena deployment and return 404; do not build a checkout flow around this endpoint.
- [Get Usage History](https://docs.tryopencomputer.com/api-reference/organizations/get-usage-history.md): Read paginated organization usage runs. Date bounds use ISO 8601 timestamps; filters must use the supported structured filter contract.
- [Download Usage Runs Report](https://docs.tryopencomputer.com/api-reference/organizations/download-usage-runs-report.md): Download CSV matching the supported usage-run date and filter parameters. Check Content-Type; successful output is not JSON.
- [Get Daily Usage Breakdown](https://docs.tryopencomputer.com/api-reference/organizations/get-daily-usage-breakdown.md): Read a daily usage breakdown only for organizations with pricing configured. The currently verified unpriced account receives 400; no charge amounts should be inferred from that absence.
- [Get Daily Report](https://docs.tryopencomputer.com/api-reference/organizations/get-daily-report.md): Read organization or workflow-filtered daily statistics using a YYYY-MM-DD date and explicit IANA timezone.
- [Get Workflow Options](https://docs.tryopencomputer.com/api-reference/organizations/get-workflow-options.md): List organization workflows available in report selectors. Use workflow_id to restrict supported report endpoints to one agent.
- [Get Daily Runs Detail](https://docs.tryopencomputer.com/api-reference/organizations/get-daily-runs-detail.md): Read detailed runs for a date and IANA timezone, optionally restricted to a workflow. These details can contain conversation data; keep exports private.
- [Get Catalog](https://docs.tryopencomputer.com/api-reference/model-connections/get-catalog.md): Read supported providers, services, and settings. Available catalog entries and configured connections are separate concepts. See [Models](/guides/models).
- [List Connections](https://docs.tryopencomputer.com/api-reference/model-connections/list-connections.md): List reusable provider connections. Responses expose configured credential names, not credential values. Use include_archived when needed.
- [Create Connection](https://docs.tryopencomputer.com/api-reference/model-connections/create-connection.md): Create and validate a provider connection. Credentials and connection_settings are separate from per-service model settings; a write may perform provider validation.
- [Archive Connection](https://docs.tryopencomputer.com/api-reference/model-connections/archive-connection.md): Archive a provider connection. Referenced connections can be protected by conflict checks; inspect 409 before removing a connection used by a configuration.
- [Update Connection](https://docs.tryopencomputer.com/api-reference/model-connections/update-connection.md): Update selected connection fields with optimistic revision checking. Omitted credential keys stay unchanged; explicit null inside credentials removes a key. A stale revision returns 409.
- [Restore Connection](https://docs.tryopencomputer.com/api-reference/model-connections/restore-connection.md): Reactivate a previously archived organization-owned provider connection.
- [List Configurations](https://docs.tryopencomputer.com/api-reference/model-connections/list-configurations.md): List reusable named model configurations. Configuration specs reference provider connections without embedding their credentials.
- [Create Configuration](https://docs.tryopencomputer.com/api-reference/model-connections/create-configuration.md): Create a named pipeline or realtime configuration. Pipeline requires LLM, STT, and TTS; realtime requires LLM and realtime selections. Referenced connections must be valid for the organization.
- [Get Configuration](https://docs.tryopencomputer.com/api-reference/model-connections/get-configuration.md): Read one named model configuration by its UUID, including revision and public settings.
- [Archive Configuration](https://docs.tryopencomputer.com/api-reference/model-connections/archive-configuration.md): Archive the named model configuration when allowed by its references and default usage. This does not change an agent to another configuration automatically.
- [Update Configuration](https://docs.tryopencomputer.com/api-reference/model-connections/update-configuration.md): Update the named configuration with optional revision checking. Omit unchanged fields. A stale revision or incompatible default embedding change can be rejected.
- [Restore Configuration](https://docs.tryopencomputer.com/api-reference/model-connections/restore-configuration.md): Validate referenced connections and restore the archived model configuration.
- [Get Default Configuration](https://docs.tryopencomputer.com/api-reference/model-connections/get-default-configuration.md): Read the UUID of the organization's default named configuration. A missing default is represented separately from the model catalog.
- [Set Default Configuration](https://docs.tryopencomputer.com/api-reference/model-connections/set-default-configuration.md): Select an existing named model configuration as the organization default. This affects agents that inherit it and validates embedding compatibility.
- [Preview Configuration](https://docs.tryopencomputer.com/api-reference/model-connections/preview-configuration.md): Resolve supported configuration layers and return a public snapshot with provenance. This previews configuration selection, not successful inference or a completed call.
- [Generate a signed S3 URL](https://docs.tryopencomputer.com/api-reference/s3/generate-a-signed-s3-url.md): Authorize a supported storage key and return a time-limited URL. Treat it as a secret capability; prefer run-media URLs when building recording playback.
- [Get file metadata for debugging](https://docs.tryopencomputer.com/api-reference/s3/get-file-metadata-for-debugging.md): Read metadata for a supported, authorized storage key. Unsupported key formats are rejected.
- [Generate a presigned URL for direct CSV upload](https://docs.tryopencomputer.com/api-reference/s3/generate-a-presigned-url-for-direct-csv-upload.md): Request a presigned upload URL for a CSV up to the schema's size limit. PUT the file to that URL before using file_key as a campaign source.
- [Initialize Embed Session](https://docs.tryopencomputer.com/api-reference/public/initialize-embed-session.md): Initialize a voice or text session using an embed token and an allowed website origin. This can start real model work. Browser API keys are not required and must not be exposed. See [Website](/guides/website).
- [Options Init](https://docs.tryopencomputer.com/api-reference/public/options-init.md): Check preflight access for the corresponding embed operation. Origin and token/session checks still apply. A successful OPTIONS response does not initialize a conversation or verify model output.
- [Stream Initialize Embed Chat](https://docs.tryopencomputer.com/api-reference/public/stream-initialize-embed-chat.md): Initialize a text embed session and receive its turn through server-sent events. Token limits and allowed-origin checks still apply.
- [Options Init](https://docs.tryopencomputer.com/api-reference/public/options-init-1.md): Check preflight access for the corresponding embed operation. Origin and token/session checks still apply. A successful OPTIONS response does not initialize a conversation or verify model output.
- [Get Embed Config](https://docs.tryopencomputer.com/api-reference/public/get-embed-config.md): Read the public widget configuration for an active embed token from an allowed origin. A successful configuration fetch does not initialize a conversation.
- [Options Embed Config](https://docs.tryopencomputer.com/api-reference/public/options-embed-config.md): Check preflight access for the corresponding embed operation. Origin and token/session checks still apply. A successful OPTIONS response does not initialize a conversation or verify model output.
- [Get Public Turn Credentials](https://docs.tryopencomputer.com/api-reference/public/get-public-turn-credentials.md): Obtain supported TURN connection details using an active embed session token and allowed origin. Treat returned credentials as temporary secrets.
- [Options Turn Credentials](https://docs.tryopencomputer.com/api-reference/public/options-turn-credentials.md): Check preflight access for the corresponding embed operation. Origin and token/session checks still apply. A successful OPTIONS response does not initialize a conversation or verify model output.
- [Get Public Chat Session](https://docs.tryopencomputer.com/api-reference/public/get-public-chat-session.md): Read the public transcript and revision for an authorized embed chat session. Use this to resynchronize after a revision conflict.
- [Options Public Chat Session](https://docs.tryopencomputer.com/api-reference/public/options-public-chat-session.md): Check preflight access for the corresponding embed operation. Origin and token/session checks still apply. A successful OPTIONS response does not initialize a conversation or verify model output.
- [End Public Chat Session](https://docs.tryopencomputer.com/api-reference/public/end-public-chat-session.md): Complete the embed text session using its session token and allowed origin. This is distinct from revoking the workflow's embed token.
- [Options Public Chat End](https://docs.tryopencomputer.com/api-reference/public/options-public-chat-end.md): Check preflight access for the corresponding embed operation. Origin and token/session checks still apply. A successful OPTIONS response does not initialize a conversation or verify model output.
- [Post Public Chat Message](https://docs.tryopencomputer.com/api-reference/public/post-public-chat-message.md): Send a message using the embed session token, origin, and supported revision fields. A stale revision returns 409; ended or unavailable sessions cannot continue.
- [Options Public Chat Messages](https://docs.tryopencomputer.com/api-reference/public/options-public-chat-messages.md): Check preflight access for the corresponding embed operation. Origin and token/session checks still apply. A successful OPTIONS response does not initialize a conversation or verify model output.
- [Stream Public Chat Message](https://docs.tryopencomputer.com/api-reference/public/stream-public-chat-message.md): Send a public chat message and read the resulting server-sent events to completion. HTTP acceptance alone does not prove that the model turn completed.
- [Options Public Chat Messages](https://docs.tryopencomputer.com/api-reference/public/options-public-chat-messages-1.md): Check preflight access for the corresponding embed operation. Origin and token/session checks still apply. A successful OPTIONS response does not initialize a conversation or verify model output.
- [Initiate Call](https://docs.tryopencomputer.com/api-reference/public/initiate-call.md): Start a real phone call using an API-trigger UUID and the published workflow definition. Preserve workflow_run_id and inspect the final run. See [Calls](/guides/calls).
- [Initiate Call Test](https://docs.tryopencomputer.com/api-reference/public/initiate-call-test.md): Start a real phone call using a trigger UUID and the latest draft, falling back to the published definition. The test path is not a dry run or sandbox.
- [Initiate Call By Workflow Uuid](https://docs.tryopencomputer.com/api-reference/public/initiate-call-by-workflow-uuid.md): Start a real phone call using workflow_uuid and the released definition. Optional explicit telephony and caller-ID fields make routing deterministic. See [Calls](/guides/calls).
- [Initiate Call Test By Workflow Uuid](https://docs.tryopencomputer.com/api-reference/public/initiate-call-test-by-workflow-uuid.md): Start a real phone call using workflow_uuid and the latest draft, falling back to the published definition. The test path changes definition selection, not whether dialing occurs.
- [Download Workflow Artifact](https://docs.tryopencomputer.com/api-reference/public/download-workflow-artifact.md): Read a recording or transcript using its artifact access token. Anyone possessing the capability can use it. Invalid tokens and missing artifacts return 404; private storage streams the file, while supported object storage can redirect.
- [Get presigned URL for document upload](https://docs.tryopencomputer.com/api-reference/knowledge-base/get-presigned-url-for-document-upload.md): Request an upload URL and document UUID. PUT the document to that URL, then call process-document with the returned s3_key. Requesting the URL does not create searchable content.
- [Trigger document processing](https://docs.tryopencomputer.com/api-reference/knowledge-base/trigger-document-processing.md): Create the document record and enqueue asynchronous processing. Select chunked retrieval for vector search or full_document for full-text use. Poll processing_status; request acceptance is not processing completion.
- [List documents](https://docs.tryopencomputer.com/api-reference/knowledge-base/list-documents.md): List active knowledge documents in the selected organization using supported pagination and retrieval filters.
- [Get document details](https://docs.tryopencomputer.com/api-reference/knowledge-base/get-document-details.md): Read document metadata, processing_status, and has_live_content. During re-indexing, the last successful content may still serve agents.
- [Delete document](https://docs.tryopencomputer.com/api-reference/knowledge-base/delete-document.md): Soft-delete the document through its active-state lifecycle. This is not a promise that stored source bytes or historical records are permanently purged.
- [Get editable document content](https://docs.tryopencomputer.com/api-reference/knowledge-base/get-editable-document-content.md): Read a supported text or Markdown document's content and file_hash. Keep the hash to detect concurrent changes on the next save.
- [Replace document content and re-index](https://docs.tryopencomputer.com/api-reference/knowledge-base/replace-document-content-and-re-index.md): Replace editable document content using expected_file_hash from the read response. A stale hash or processing conflict returns 409. Re-indexing runs asynchronously; prior content remains available until replacement succeeds.
- [Search for similar chunks](https://docs.tryopencomputer.com/api-reference/knowledge-base/search-for-similar-chunks.md): Search chunked documents using the configured embedding service. Restrict document_uuids when you need a specific corpus. Full-document storage and vector-search availability are separate concerns.
- [Get presigned URLs for recording uploads](https://docs.tryopencomputer.com/api-reference/workflow-recordings/get-presigned-urls-for-recording-uploads.md): Request one or more audio upload URLs. PUT each file separately before creating recording metadata. Each file and batch must satisfy the schema's size limits.
- [List recordings](https://docs.tryopencomputer.com/api-reference/workflow-recordings/list-recordings.md): List reusable workflow recordings and transcript metadata using the supported filters. These are uploaded assets, not a list of every call recording.
- [Create recording records after upload](https://docs.tryopencomputer.com/api-reference/workflow-recordings/create-recording-records-after-upload.md): Create recording metadata after uploading files. recording_id is the short recording identifier returned by the upload preparation, while id is the numeric metadata identifier.
- [Delete a recording](https://docs.tryopencomputer.com/api-reference/workflow-recordings/delete-a-recording.md): Deactivate recording metadata by its recording_id. The product's soft-delete behavior is distinct from purging stored audio.
- [Update a recording's Recording ID](https://docs.tryopencomputer.com/api-reference/workflow-recordings/update-a-recordings-recording-id.md): Update the descriptive recording_id using the numeric id in this route. The new identifier accepts letters, numbers, hyphens, and underscores.
- [Transcribe an audio file](https://docs.tryopencomputer.com/api-reference/workflow-recordings/transcribe-an-audio-file.md): Upload audio using the multipart schema to request transcription through the configured service. This performs external model work; provider availability is separate from file upload success.
- [Get short-lived playback URLs for a run's recordings and transcript](https://docs.tryopencomputer.com/api-reference/workflow-runs/get-short-lived-playback-urls-for-a-runs-recordings-and-transcript.md): Authorize a run and mint short-lived playback URLs for available artifacts. Missing artifacts produce null URLs. Playback requires a configured signing secret and returns 503 when signing is unavailable.
- [Stream a run's recording or transcript (token from /media-token)](https://docs.tryopencomputer.com/api-reference/workflow-runs/stream-a-runs-recording-or-transcript-token-from-media-token.md): Read a supported run artifact using a signed media token. HTTP Range requests are supported. Tokens and artifact URLs grant access and must be kept private.
- [Get Retry Review Status](https://docs.tryopencomputer.com/api-reference/retry-review/get-retry-review-status.md): Read enabled retry-review behavior, supported outcomes, causes, and the maximum review reruns. Disabled deployments return 404. See [Retries](/guides/retries).
- [Get Retry Review Candidates](https://docs.tryopencomputer.com/api-reference/retry-review/get-retry-review-candidates.md): Read ranked, organization-scoped call outcomes. The default window is seven days. can_rerun, blocked_reason, calling hours, newer attempts, and review holds determine actionability; eligibility is rechecked when a rerun is requested.
- [Post Retry Review Rerun](https://docs.tryopencomputer.com/api-reference/retry-review/post-retry-review-rerun.md): Request real reruns for selected run_ids. Responses are per run. wait_for_line and bulk affect queuing and selection; campaign calls follow their campaign queue. A retryable outcome alone does not override a ranking hold or retry ceiling.
- [List Folders](https://docs.tryopencomputer.com/api-reference/folder/list-folders.md): List folders in the selected organization.
- [Create Folder](https://docs.tryopencomputer.com/api-reference/folder/create-folder.md): Create an organization-owned folder. Whitespace-only names are rejected and duplicate names can return 409.
- [Rename Folder](https://docs.tryopencomputer.com/api-reference/folder/rename-folder.md): Rename the accessible folder while preserving its assigned agents.
- [Delete Folder](https://docs.tryopencomputer.com/api-reference/folder/delete-folder.md): Delete the folder and move its agents to Uncategorized. This does not delete the agents themselves.
- [Get Current User](https://docs.tryopencomputer.com/api-reference/auth/get-current-user.md): Verify the caller identity and selected organization. Use X-API-Key from your backend to confirm which organization subsequent requests will use. See [Api](/guides/api).

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


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