Developer

Developer docs explain how external systems and internal integrations call Octo APIs, execute AI workflows, inspect interactions, test tools, and reason about data scoping.

Key concepts

Term	Definition
Base URL	The Octo deployment URL used for API requests. Use the environment-specific URL supplied by your team.
API key	A credential created in Settings > API Keys and sent by a trusted integration.
Space context	The working scope for product records such as workflows, tools, contacts, phone numbers, dashboards, and interactions.
Execution endpoint	An API route that starts, resumes, or finalizes workflow and interaction runtime behavior.
Runtime record	The stored execution, interaction, log, or model record created by the platform.

What you can do

Action	Description
Execute workflows	Start or resume an AI Workflow execution from a trusted integration.
Create interactions	Create an interaction record, execute it, and finalize it when the conversation ends.
Test tools	Run a configured Tool with sample fields before exposing it to an AI Agent stencil.
Generate voice	Request voice output through the voice-generation API used by voice flows.
Invoke agents	Call the agent invocation endpoint for advanced runtime integrations.
Understand scoping	Map product pages to backend model scopes and avoid cross-space data mistakes.

Authentication and tenancy

Use API keys only from trusted server-side code or controlled automation. Do not embed keys in browsers, public repositories, screenshots, capture scripts, or documentation examples. When a request depends on a selected instance or space, send the same context your application uses elsewhere in Octo.

The exact transport for authentication and scope headers can vary by deployment. If your integration contract is not already documented by your team, confirm it before exposing a workflow or interaction endpoint to production traffic.

API areas

Page	What it covers
AI Workflow Execution	Start and resume workflow executions, including payload and context shape.
Interactions	Create, execute, and finalize interaction records.
Tools	Test REST API and Script tools with explicit field values.
Agent Invocation	Invoke an agent runtime endpoint from an integration.
Voice Generation	Generate voice output for voice-enabled flows.
Storage and Scoping	Understand instances, spaces, model ownership, and frontend-to-backend mapping.
Runtime Guide	Connect Workflow Builder concepts to graph execution behavior.

Request examples

Examples use placeholders. Replace the base URL, IDs, and authorization details with values from your environment.

curl -X POST "$OCTO_BASE_URL/llm-chain/tool/test" \
  -H "Authorization: Bearer $OCTO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"toolId":"tool_123","fields":{"email":"customer@example.com"}}'

Safety checklist

1. Create a dedicated API key for each integration.
2. Store the key in a secret manager.
3. Confirm which instance and space the integration should operate in.
4. Test against a draft workflow, test tool, or non-production space first.
5. Review Audit Logs and Interactions after initial traffic.

FAQ

Are these endpoints public product APIs? They are documented for trusted integrations and developer workflows. Confirm deployment-level exposure, authentication headers, and scope requirements with your Octo administrator before treating any route as internet-facing.

Where do I find API keys? Open Settings > API Keys and create a key for the integration.

How do I debug a failed request? Check the response body, then review the related Interactions, workflow version, tool test result, and Audit Logs.

Related pages

• AI Workflows - build the workflows that execution APIs run
• Tools - configure tools before testing them through the API
• Interactions - inspect conversation and execution records