Skip to content
Changelog

Report a bug

Retell AI integration: operations for AI agents

Retell AI connects to Type.com as an integration. This page lists the 110 operations documented for Claude and Codex in Type.com: 43 read, 41 write, 26 destructive.

About Retell AI

Retell AI API reference operations, subject to Type setup and account permissions.

Categories: Communication & Meetings, Customer Support

How to connect Retell AI to Type.com

Connect
Configure provider-specific API target and authentication setup.
Access
Organization connection: one shared account for the workspace.
MCP
This integration is not available through Type’s MCP server. It remains available in Type.

To add the connection, follow the steps in Space connections.

Documented operations

110 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

110 operations listed.

Add knowledge base sources

  • Write

    Add Knowledge Base Sources

    Add sources to a knowledge base

    POST /add-knowledge-base-sources/{knowledge_base_id}

Create agent

  • Write

    Create Agent

    Create a new agent

    POST /create-agent

Create batch call

  • Write

    Create Batch Call

    Create a batch call

    POST /create-batch-call

Create batch test

  • Write

    Create Batch Test

    Create a batch test to run multiple test cases

    POST /create-batch-test

Create test case definition

  • Write

    Create Test Case Definition

    Create a new test case definition

    POST /create-test-case-definition

Delete test case definition

  • Destructive

    Delete Test Case Definition

    Delete a test case definition

    DELETE /delete-test-case-definition/{test_case_definition_id}

Get test case definition

  • Read

    Get Test Case Definition

    Get a test case definition by ID

    GET /get-test-case-definition/{test_case_definition_id}

List test case definitions

  • Read

    List Test Case Definitions

    List test case definitions with pagination

    GET /v2/list-test-case-definitions

Update test case definition

  • Write

    Update Test Case Definition

    Update a test case definition

    PUT /update-test-case-definition/{test_case_definition_id}

Get batch test

  • Read

    Get Batch Test

    Get a batch test job by ID

    GET /get-batch-test/{test_case_batch_job_id}

List batch tests

  • Read

    List Batch Tests

    List batch test jobs with pagination

    GET /v2/list-batch-tests

Get test run

  • Read

    Get Test Run

    Get a test case job (test run) by ID

    GET /get-test-run/{test_case_job_id}

List test runs

  • Read

    List Test Runs

    List test case jobs (test runs) for a batch test job with pagination

    GET /v2/list-test-runs/{test_case_batch_job_id}

Create chat agent

  • Write

    Create Chat Agent

    Create a new chat agent

    POST /create-chat-agent

Agent playground completion

  • Write

    Agent Playground Completion

    Stateless playground completion. Send the full conversation history (same shape as chat completion messages) and receive only the newly generated messages. Nothing is persisted server-side — the caller manages conversation state.

    POST /agent-playground-completion/{agent_id}

Create chat completion

  • Write

    Create Chat Completion

    Create a chat completion message

    POST /create-chat-completion

Create chat

  • Write

    Create Chat

    Create a chat session

    POST /create-chat

Create conversation flow component

  • Write

    Create Conversation Flow Component

    Create a new shared conversation flow component

    POST /create-conversation-flow-component

Create conversation flow

  • Write

    Create Conversation Flow

    Create a new Conversation Flow that can be attached to an agent. This is used to generate response output for the agent.

    POST /create-conversation-flow

Create asset

  • Write

    Create Asset

    Upload an image or audio asset. Audio is normalized to headerless mono PCM16 at 24 kHz and can be referenced by `custom_on_hold_music_asset_id` on warm and agentic-warm transfer options. Accepted audio formats are MP3, WAV, WebM, OGG, M4A, AAC, and FLAC. The maximum upload size is 10 MB and audio duration is limited to 210 seconds.

    POST /create-asset

Create knowledge base

  • Write

    Create Knowledge Base

    Create a new knowledge base

    POST /create-knowledge-base

Create phone number

  • Write

    Create Phone Number

    Buy a new phone number & Bind agents

    POST /create-phone-number

Create retell llm

  • Write

    Create Retell LLM

    Create a new Retell LLM Response Engine that can be attached to an agent. This is used to generate response output for the agent.

    POST /create-retell-llm

Create sms chat

  • Write

    Create Sms Chat

    Start an outbound SMS chat conversation with a phone number using the specified agent. The agent must be configured for chat mode. The initial SMS message will be automatically generated and sent based on the agent's configuration.

    POST /create-sms-chat

Delete agent

  • Destructive

    Delete Agent

    Delete an existing agent

    DELETE /delete-agent/{agent_id}

Delete chat

  • Destructive

    Delete Chat

    Delete an existing chat

    DELETE /delete-chat/{chat_id}

Delete chat agent

  • Destructive

    Delete Chat Agent

    Delete an existing chat agent

    DELETE /delete-chat-agent/{agent_id}

Delete conversation flow component

  • Destructive

    Delete Conversation Flow Component

    Delete a shared conversation flow component. When deleting a shared component, creates local copies for all linked conversation flows.

    DELETE /delete-conversation-flow-component/{conversation_flow_component_id}

Delete conversation flow

  • Destructive

    Delete Conversation Flow

    Delete a conversation flow and all its versions

    DELETE /delete-conversation-flow/{conversation_flow_id}

Delete knowledge base source

  • Destructive

    Delete Knowledge Base Source

    Delete an existing source from knowledge base

    DELETE /delete-knowledge-base-source/{knowledge_base_id}/source/{source_id}

Delete knowledge base

  • Destructive

    Delete Knowledge Base

    Delete an existing knowledge base

    DELETE /delete-knowledge-base/{knowledge_base_id}

Delete phone number

  • Destructive

    Delete Phone Number

    Delete an existing phone number

    DELETE /delete-phone-number/{phone_number}

Delete retell llm

  • Destructive

    Delete Retell LLM

    Delete an existing Retell LLM Response Engine

    DELETE /delete-retell-llm/{llm_id}

End chat

  • Destructive

    End Chat

    End an ongoing chat

    PATCH /end-chat/{chat_id}

List agent versions

  • Read

    List Agent Versions

    List stored versions of a voice or chat agent with pagination.

    GET /list-agent-versions/{agent_id}

Get agent

  • Read

    Get Agent

    Retrieve details of a specific agent

    GET /get-agent/{agent_id}

Get chat agent

  • Read

    Get Chat Agent

    Retrieve details of a specific chat agent

    GET /get-chat-agent/{agent_id}

Get chat

  • Read

    Get Chat

    Retrieve details of a specific chat

    GET /get-chat/{chat_id}

Get concurrency

  • Read

    Get Concurrency

    Get the current concurrency and concurrency limit of the org

    GET /get-concurrency

Get api key info

  • Read

    Get Api Key Info

    Get info about the API key used to authenticate, and the org that owns it.

    GET /get-api-key-info

Get conversation flow component

  • Read

    Get Conversation Flow Component

    Get a shared conversation flow component

    GET /get-conversation-flow-component/{conversation_flow_component_id}

Get conversation flow

  • Read

    Get Conversation Flow

    Retrieve details of a specific Conversation Flow

    GET /get-conversation-flow/{conversation_flow_id}

Get knowledge base

  • Read

    Get Knowledge Base

    Retrieve details of a specific knowledge base

    GET /get-knowledge-base/{knowledge_base_id}

Get mcp tools

  • Read

    Get MCPTools

    Get MCP tools for a specific agent

    GET /get-mcp-tools/{agent_id}

Get phone number

  • Read

    Get Phone Number

    Retrieve details of a specific phone number

    GET /get-phone-number/{phone_number}

Get retell llm

  • Read

    Get Retell LLM

    Retrieve details of a specific Retell LLM Response Engine

    GET /get-retell-llm/{llm_id}

Get voice

  • Read

    Get Voice

    Retrieve details of a specific voice

    GET /get-voice/{voice_id}

Clone voice

  • Write

    Clone Voice

    Clone a voice from audio files

    POST /clone-voice

Add community voice

  • Write

    Add Community Voice

    Add a community voice to the voice library

    POST /add-community-voice

Search community voice

  • Read

    Search Community Voice

    Search for community voices from voice providers

    POST /search-community-voice

Import phone number

  • Write

    Import Phone Number

    Import a phone number from custom telephony & Bind agents

    POST /import-phone-number

List agents

  • Read

    List Agents

    List unique agents with pagination.

    POST /v2/list-agents

List chats

  • Read

    List Chats

    List chats with unified cursor pagination response.

    POST /v3/list-chats

List conversation flow components

  • Read

    List Conversation Flow Components

    List shared conversation flow components with pagination

    GET /v2/list-conversation-flow-components

List conversation flows

  • Read

    List Conversation Flows

    List conversation flows with pagination

    GET /v2/list-conversation-flows

List knowledge bases

  • Read

    List Knowledge Bases

    List all knowledge bases

    GET /list-knowledge-bases

List phone numbers

  • Read

    List Phone Numbers

    List phone numbers with pagination

    GET /v2/list-phone-numbers

List retell llms

  • Read

    List Retell LLM

    List Retell LLM Response Engines with pagination

    GET /v2/list-retell-llms

List voices

  • Read

    List Voices

    List all voices available to the user

    GET /list-voices

Create agent version

  • Write

    Create Agent Version

    Create a new draft agent version from a base version.

    POST /create-agent-version/{agent_id}

Publish agent version

  • Write

    Publish Agent Version

    Publish an existing draft version in place.

    POST /publish-agent-version/{agent_id}

Delete agent version

  • Destructive

    Delete Agent Version

    Delete a specific agent version.

    DELETE /delete-agent-version/{agent_id}

API

  • Write

    refreshKnowledgeBase

    Manually refresh a knowledge base

    POST /refresh-knowledge-base/{knowledge_base_id}

Rerun call analysis

  • Write

    Rerun Call Analysis

    Rerun post-call analysis for a specific call. This operation incurs charges.

    PUT /rerun-call-analysis/{call_id}

Rerun chat analysis

  • Write

    Rerun Chat Analysis

    Rerun post-chat analysis for a specific chat. This operation incurs charges.

    PUT /rerun-chat-analysis/{chat_id}

Update agent

  • Destructive

    Update Agent

    Update an existing agent's latest draft version

    PATCH /update-agent/{agent_id}

Repair agent

  • Destructive

    Repair Agent

    Remove references to resources that no longer exist in your workspace from an agent draft version and its response engine — tools whose app connection has been deleted, unknown knowledge bases, and deleted shared components — and remap voices that are no longer accessible to a default voice. If the agent's response engine version has been published, the engine is left untouched and only agent-level references are repaired. Repairing an agent with nothing to fix is a no-op.

    POST /repair-agent/{agent_id}

Update chat agent

  • Destructive

    Update Chat Agent

    Update an existing chat agent

    PATCH /update-chat-agent/{agent_id}

Update chat

  • Write

    Update Chat Metadata

    Update metadata and sensitive data storage settings for an existing chat.

    PATCH /update-chat/{chat_id}

Update conversation flow component

  • Write

    Update Conversation Flow Component

    Update an existing shared conversation flow component

    PATCH /update-conversation-flow-component/{conversation_flow_component_id}

Update conversation flow

  • Destructive

    Update Conversation Flow

    Update an existing conversation flow

    PATCH /update-conversation-flow/{conversation_flow_id}

Update phone number

  • Write

    Update Phone Number

    Update settings for a phone number. SIP codec preferences apply only to custom phone numbers.

    PATCH /update-phone-number/{phone_number}

Update retell llm

  • Destructive

    Update Retell LLM

    Update an existing Retell LLM Response Engine

    PATCH /update-retell-llm/{llm_id}

Create phone call

  • Write

    Create Phone Call

    Create a new outbound phone call.

    POST /v2/create-phone-call

Create web call

  • Write

    Create Web Call

    Create a new web call and return browser connection details.

    POST /v3/create-web-call

Delete call

  • Destructive

    Delete Call

    Delete a specific call and its associated data

    DELETE /v2/delete-call/{call_id}

Get call

  • Read

    Get Call

    Retrieve details of a specific call

    GET /v2/get-call/{call_id}

Listen live call

  • Write

    Listen Live Call

    Mint a subscribe-only access token for an in-progress call so a client can listen to live audio. The returned token grants join + subscribe on the call's existing audio room; it cannot publish. The call must be in ONGOING status.

    POST /v2/listen-live-call/{call_id}

Take over live call

  • Destructive

    Take Over Live Call

    Take over an in-progress call from the AI agent. The agent stops responding and the specified live-listen participant is allowed to speak directly to the caller. The call must be in ONGOING status. Calls cannot be taken over while a PCI session is active.

    POST /v2/take-over-live-call/{call_id}

List calls

  • Read

    List Calls

    List calls with unified cursor pagination response.

    POST /v3/list-calls

List export requests

  • Read

    List Export Requests

    List export requests with pagination

    GET /v2/list-export-requests

Register phone call

  • Write

    Register Phone Call

    Register a new phone call for custom telephony

    POST /v2/register-phone-call

Update call

  • Write

    Update Call Metadata

    Update metadata and sensitive data storage settings for an existing call.

    PATCH /v2/update-call/{call_id}

Update live call

  • Write

    Update Live Call

    Update an ongoing call at runtime. Supports overriding dynamic variables, metadata, and the data storage setting on the running call, and controlling the live agent (inject context, trigger a response). These overrides take effect immediately on the live call; metadata and data storage setting changes are also persisted to the call record. To update a call that is no longer ongoing, use /v2/update-call/{call_id}.

    PATCH /v2/update-live-call/{call_id}

Stop call

  • Destructive

    Stop Call

    Stop an ongoing call.

    POST /v2/stop-call/{call_id}

Create contact

  • Write

    Create Contact

    Create a new contact.

    POST /create-contact

Upload contact import file

  • Write

    Upload Contact Import File

    Upload a CSV file for a contact import. The file is stored privately and referenced by the returned upload_id in create-contact-import.

    POST /upload-contact-import-file

Create contact import

  • Destructive

    Create Contact Import

    Start an incremental contact import from an uploaded CSV: creates new contacts and updates existing ones matched by phone number. Mapped columns overwrite the matched contact's fields; unmapped columns are ignored. Runs asynchronously — poll get-contact-import for progress.

    POST /create-contact-import

Get contact import

  • Read

    Get Contact Import

    Status and counts for the org's current or latest contact import.

    GET /get-contact-import

Get contact

  • Read

    Get Contact

    Retrieve a contact by ID.

    GET /get-contact/{contact_id}

Get contact by phone

  • Read

    Get Contact By Phone

    Retrieve a contact by phone number. At most one contact exists per phone number in an organization.

    GET /get-contact-by-phone/{phone_number}

Update contact

  • Destructive

    Update Contact

    Update an existing contact.

    PATCH /update-contact/{contact_id}

Delete contact

  • Destructive

    Delete Contact

    Delete a contact. A contact linked to a record in a connected CRM cannot be deleted while two-way sync is active — unlink the CRM app first, otherwise the next sync would recreate it.

    DELETE /delete-contact/{contact_id}

List contacts

  • Read

    List Contacts

    List contacts, newest created first by default, with the total count of matches alongside the page. Page through results with `pagination_key`; `skip` is available for offset-style paging but is slower on large contact sets and can repeat or miss rows as contacts are added or deleted.

    POST /list-contacts

List contact conversations

  • Read

    List Contact Conversations

    List a contact's conversations (inbound calls, outbound calls, and chats) merged into a single timeline, most recent first. Results are matched by the contact's phone number. Use the returned `pagination_key` to fetch the next page.

    GET /list-contact-conversations/{contact_id}

Create app

  • Write

    Create App

    Create an App: the connection to one external system (a CRM, calendar, support desk, and so on), holding its credentials and settings. Providers with caller-managed credentials accept auth_config. Providers using OAuth must omit auth_config and be authorized through connect-app. Providers supporting both methods, such as Cal.com, also accept caller-managed API keys. Credentials are stored encrypted and never returned. Up to 20 apps per provider by default, unless a custom limit is configured for the organization.

    POST /create-app

Get app

  • Read

    Get App

    Get an App by id.

    GET /get-app/{app_id}

Update app

  • Destructive

    Update App

    Partially update an App. Omitted fields remain unchanged. Updating auth_config or tenant metadata invalidates the cached provider token immediately. OAuth-only providers reject auth_config and must be reauthorized through connect-app. Providers supporting caller-managed credentials as well, such as Cal.com, continue to accept those credentials.

    PATCH /update-app/{app_id}

Delete app

  • Destructive

    Delete App

    Delete an App. Fails when agents or knowledge bases still reference it, unless force_delete is set. If a CRM config is linked to this App, the link is cleared.

    DELETE /delete-app/{app_id}

List apps

  • Read

    List Apps

    List Apps in the organization (paginated).

    GET /list-apps

List app usages

  • Read

    List App Usages

    List the agents and knowledge bases referencing an App, most recently configured first by default.

    GET /list-app-usages/{app_id}

Test app auth

  • Write

    Test App Auth

    Probe the App's stored credentials by making a minimal authenticated call to the provider. Returns success=true on a successful round-trip, and records the outcome on the App's connection_status either way.

    POST /test-app-auth/{app_id}

Get app tool schema

  • Write

    Get App Tool Schema

    One round of multi-step schema resolution for an app tool template against a connected App. parameters is the input parameters resolved so far, with properties configured by const or description, and is empty on the first call. Returns the next input_schema to fill; complete marks the last round (it may accompany the final input_schema) and may include an optional response_schema. Input-schema property descriptions provide the default text for LLM inference, and each property's default_input_mode ("const" or "description") is the input mode to preselect for it. A property may also carry extra_info ({ text?, link? }), guidance to render under its editor, e.g. a docs link on how to find an id. Used by the tool config UI. enum_labels maps enum values to display labels; forbid_literal_const allows only description or a {{variable}}.

    POST /get-app-tool-schema/{app_id}

Get crm config

  • Read

    Get Crm Config

    Get the organization's CRM configuration: which CRM app is linked, the custom contact fields defined for it, and how post-call analysis data is written back to contacts. Returns an empty configuration when nothing has been set up yet.

    GET /get-crm-config

Update crm config

  • Destructive

    Update Crm Config

    Update the organization's CRM configuration. Omitted fields stay as they are; a field that is sent replaces its stored value in full.

    POST /update-crm-config

Run sync job

  • Write

    Run Sync Job

    Start a contact sync with the linked CRM app immediately, instead of waiting for the scheduled sync. One sync runs per organization at a time: starting another while one is in flight is rejected. Poll get-sync-job-status for progress.

    POST /run-sync-job

Get sync job status

  • Read

    Get Sync Job Status

    Get the status of the organization's contact sync, whether it was started manually or by the schedule. Returns status `idle` when no sync is running.

    GET /get-sync-job-status

Backfill contact analysis data

  • Write

    Backfill Contact Analysis Data

    Trigger a backfill job that re-applies analysis data mappings to contacts using historical call and SMS chat data. Only one backfill job can run per organization at a time. Select contact_memory to rewrite memory from matching ended phone calls and SMS chats in chronological order, one conversation at a time, with no conversation-count cap. Backfill starts with the contact's existing memory. Each rewrite builds on the previous result, and the final successful result is saved once per contact. When mapped analysis fields and contact_memory are selected together, they are saved together in one contact update. Memory rewrites use the currently stored contact fields.

    POST /backfill-contact-analysis-data

Get backfill contact job status

  • Read

    Get Backfill Contact Job Status

    Get the status of the contact analysis data backfill job.

    GET /get-backfill-contact-job-status

Get crm schema

  • Read

    Get Crm Schema

    Get the contact schema of the connected CRM: the fields available on its contact object, which are the values that sync mappings can reference.

    GET /get-crm-schema

See How connections work for access and permissions, or browse all integrations.

Reference date: October 29, 2026. Retell AI API docs.