Skip to main content
This guide starts with an existing Leamout organization and a scoped organization API credential. All requests use https://api.leamout.com. To establish an account or obtain SIP ingress details, use your Leamout onboarding channel.

​
1. Configure an API client

Use a token that includes voice-agents:read and voice-agents:write. Organization tokens supply their organization context and do not use X-Organization-ID.

​
2. Create a Voice Agent

Save the id returned in the response’s data object as VOICE_AGENT_ID. This creates agent configuration; it does not yet make the agent ready to take calls.

​
3. Connect and verify an AI integration

Add an organization-owned integration using POST /v1/ai-integrations/ with a supported provider, a name, and a secret. Verify it with POST /v1/ai-integrations/{integration_id}/verify. Then bind the integration to the agent’s realtime role, or use stt, llm, and tts for a composable agent. See AI integrations for the exact steps.

​
4. Check agent readiness

Look for data.ready: true. If it is false, inspect data.issues for missing or unverified provider bindings.

​
5. Connect telephony

Configure your existing SIP carrier as a trunk, attach an existing phone number, then create the agent’s inbound phone-number binding. For an outbound call, use POST /v1/calls/ with voice_agent_id, trunk_id, from_uri, and to_uri as appropriate.
Do not send a live test call until your organization’s inbound SIP ingress, routing, credentials, provider integrations, and available runtime allowance are configured.