api.md

Call

Types:

from retell.types import (
    CallResponse,
    CreateWebCallResponse,
    PhoneCallResponse,
    WebCallResponse,
    CallListResponse,
    CallListenLiveResponse,
    CallTakeOverLiveResponse,
    CallUpdateLiveResponse,
)

Methods:

• client.call.retrieve(call_id) -> CallResponse
• client.call.update(call_id, **params) -> CallResponse
• client.call.list(**params) -> CallListResponse
• client.call.delete(call_id) -> None
• client.call.create_phone_call(**params) -> PhoneCallResponse
• client.call.create_web_call(**params) -> CreateWebCallResponse
• client.call.listen_live(call_id) -> CallListenLiveResponse
• client.call.register_phone_call(**params) -> PhoneCallResponse
• client.call.rerun_analysis(call_id) -> CallResponse
• client.call.stop(call_id) -> None
• client.call.take_over_live(call_id, **params) -> CallTakeOverLiveResponse
• client.call.update_live(call_id, **params) -> CallUpdateLiveResponse

Chat

Types:

from retell.types import ChatResponse, ChatListResponse, ChatCreateChatCompletionResponse

Methods:

• client.chat.create(**params) -> ChatResponse
• client.chat.retrieve(chat_id) -> ChatResponse
• client.chat.update(chat_id, **params) -> ChatResponse
• client.chat.list(**params) -> ChatListResponse
• client.chat.delete(chat_id) -> None
• client.chat.create_chat_completion(**params) -> ChatCreateChatCompletionResponse
• client.chat.create_sms_chat(**params) -> ChatResponse
• client.chat.end(chat_id) -> None
• client.chat.rerun_analysis(chat_id) -> ChatResponse

PhoneNumber

Types:

from retell.types import PhoneNumberResponse, PhoneNumberListResponse

Methods:

• client.phone_number.create(**params) -> PhoneNumberResponse
• client.phone_number.retrieve(phone_number) -> PhoneNumberResponse
• client.phone_number.update(phone_number, **params) -> PhoneNumberResponse
• client.phone_number.list(**params) -> PhoneNumberListResponse
• client.phone_number.delete(phone_number) -> None
• client.phonenumber.import(**params) -> PhoneNumberResponse

Agent

Types:

from retell.types import (
    AgentResponse,
    AgentListResponse,
    AgentCreateVersionResponse,
    AgentListVersionsResponse,
    AgentRepairResponse,
)

Methods:

• client.agent.create(**params) -> AgentResponse
• client.agent.retrieve(agent_id, **params) -> AgentResponse
• client.agent.update(agent_id, **params) -> AgentResponse
• client.agent.list(**params) -> AgentListResponse
• client.agent.delete(agent_id) -> None
• client.agent.create_version(agent_id, **params) -> AgentCreateVersionResponse
• client.agent.delete_version(agent_id, **params) -> None
• client.agent.list_versions(agent_id, **params) -> AgentListVersionsResponse
• client.agent.publish(agent_id, **params) -> None
• client.agent.repair(agent_id, **params) -> AgentRepairResponse

ChatAgent

Types:

from retell.types import ChatAgentResponse, ChatAgentListResponse, ChatAgentCreateVersionResponse

Methods:

• client.chat_agent.create(**params) -> ChatAgentResponse
• client.chat_agent.retrieve(agent_id, **params) -> ChatAgentResponse
• client.chat_agent.update(agent_id, **params) -> ChatAgentResponse
• client.chat_agent.list(**params) -> ChatAgentListResponse
• client.chat_agent.delete(agent_id) -> None
• client.chat_agent.create_version(agent_id, **params) -> ChatAgentCreateVersionResponse
• client.chat_agent.delete_version(agent_id, **params) -> None
• client.chat_agent.publish(agent_id, **params) -> None

Llm

Types:

from retell.types import LlmResponse, LlmListResponse

Methods:

• client.llm.create(**params) -> LlmResponse
• client.llm.retrieve(llm_id, **params) -> LlmResponse
• client.llm.update(llm_id, **params) -> LlmResponse
• client.llm.list(**params) -> LlmListResponse
• client.llm.delete(llm_id, **params) -> None

ConversationFlow

Types:

from retell.types import ConversationFlowResponse, ConversationFlowListResponse

Methods:

• client.conversation_flow.create(**params) -> ConversationFlowResponse
• client.conversation_flow.retrieve(conversation_flow_id, **params) -> ConversationFlowResponse
• client.conversation_flow.update(conversation_flow_id, **params) -> ConversationFlowResponse
• client.conversation_flow.list(**params) -> ConversationFlowListResponse
• client.conversation_flow.delete(conversation_flow_id, **params) -> None

ConversationFlowComponent

Types:

from retell.types import ConversationFlowComponentResponse, ConversationFlowComponentListResponse

Methods:

• client.conversation_flow_component.create(**params) -> ConversationFlowComponentResponse
• client.conversation_flow_component.retrieve(conversation_flow_component_id) -> ConversationFlowComponentResponse
• client.conversation_flow_component.update(conversation_flow_component_id, **params) -> ConversationFlowComponentResponse
• client.conversation_flow_component.list(**params) -> ConversationFlowComponentListResponse
• client.conversation_flow_component.delete(conversation_flow_component_id) -> None

KnowledgeBase

Types:

from retell.types import KnowledgeBaseResponse, KnowledgeBaseListResponse

Methods:

• client.knowledge_base.create(**params) -> KnowledgeBaseResponse
• client.knowledge_base.retrieve(knowledge_base_id) -> KnowledgeBaseResponse
• client.knowledge_base.list() -> KnowledgeBaseListResponse
• client.knowledge_base.delete(knowledge_base_id) -> None
• client.knowledge_base.add_sources(knowledge_base_id, **params) -> KnowledgeBaseResponse
• client.knowledge_base.delete_source(source_id, *, knowledge_base_id) -> KnowledgeBaseResponse

Voice

Types:

from retell.types import VoiceResponse, VoiceListResponse, VoiceSearchResponse

Methods:

• client.voice.retrieve(voice_id) -> VoiceResponse
• client.voice.list() -> VoiceListResponse
• client.voice.add_resource(**params) -> VoiceResponse
• client.voice.clone(**params) -> VoiceResponse
• client.voice.search(**params) -> VoiceSearchResponse

Asset

Types:

from retell.types import AssetCreateResponse

Methods:

• client.asset.create(**params) -> AssetCreateResponse

Concurrency

Types:

from retell.types import ConcurrencyRetrieveResponse

Methods:

• client.concurrency.retrieve() -> ConcurrencyRetrieveResponse

Identity

Types:

from retell.types import IdentityRetrieveResponse

Methods:

• client.identity.retrieve() -> IdentityRetrieveResponse

ExportRequest

Types:

from retell.types import ExportRequestListResponse

Methods:

• client.export_request.list(**params) -> ExportRequestListResponse

BatchCall

Types:

from retell.types import BatchCallResponse

Methods:

• client.batch_call.create_batch_call(**params) -> BatchCallResponse

Tests

Types:

from retell.types import (
    BatchTestResponse,
    TestCaseDefinitionResponse,
    TestCaseJobResponse,
    TestListBatchTestsResponse,
    TestListTestCaseDefinitionsResponse,
    TestListTestRunsResponse,
)

Methods:

• client.tests.create_batch_test(**params) -> BatchTestResponse
• client.tests.create_test_case_definition(**params) -> TestCaseDefinitionResponse
• client.tests.delete_test_case_definition(test_case_definition_id) -> None
• client.tests.get_batch_test(test_case_batch_job_id) -> BatchTestResponse
• client.tests.get_test_case_definition(test_case_definition_id) -> TestCaseDefinitionResponse
• client.tests.get_test_run(test_case_job_id) -> TestCaseJobResponse
• client.tests.list_batch_tests(**params) -> TestListBatchTestsResponse
• client.tests.list_test_case_definitions(**params) -> TestListTestCaseDefinitionsResponse
• client.tests.list_test_runs(test_case_batch_job_id, **params) -> TestListTestRunsResponse
• client.tests.update_test_case_definition(test_case_definition_id, **params) -> TestCaseDefinitionResponse

Playground

Types:

from retell.types import PlaygroundCompletionResponse

Methods:

• client.playground.completion(agent_id, **params) -> PlaygroundCompletionResponse

McpTool

Types:

from retell.types import McpToolDefinition, McpToolGetMcpToolsResponse

Methods:

• client.mcp_tool.get_mcp_tools(agent_id, **params) -> McpToolGetMcpToolsResponse

Contact

Types:

from retell.types import (
    ContactResponse,
    ContactListResponse,
    ContactBackfillAnalysisDataResponse,
    ContactCreateImportResponse,
    ContactGetBackfillJobStatusResponse,
    ContactGetImportResponse,
    ContactListConversationsResponse,
    ContactUploadImportFileResponse,
)

Methods:

• client.contact.create(**params) -> ContactResponse
• client.contact.update(contact_id, **params) -> ContactResponse
• client.contact.list(**params) -> ContactListResponse
• client.contact.delete(contact_id) -> None
• client.contact.backfill_analysis_data(**params) -> ContactBackfillAnalysisDataResponse
• client.contact.create_import(**params) -> ContactCreateImportResponse
• client.contact.get(contact_id) -> ContactResponse
• client.contact.get_backfill_job_status() -> ContactGetBackfillJobStatusResponse
• client.contact.get_by_phone(phone_number) -> ContactResponse
• client.contact.get_import() -> ContactGetImportResponse
• client.contact.list_conversations(contact_id, **params) -> ContactListConversationsResponse
• client.contact.upload_import_file(**params) -> ContactUploadImportFileResponse

App

Types:

from retell.types import (
    AppResponse,
    AppListResponse,
    AppGetToolSchemaResponse,
    AppListUsagesResponse,
    AppTestAuthResponse,
)

Methods:

• client.app.create(**params) -> AppResponse
• client.app.update(app_id, **params) -> AppResponse
• client.app.list(**params) -> AppListResponse
• client.app.delete(app_id, **params) -> None
• client.app.get(app_id) -> AppResponse
• client.app.get_tool_schema(app_id, **params) -> AppGetToolSchemaResponse
• client.app.list_usages(app_id, **params) -> AppListUsagesResponse
• client.app.test_auth(app_id) -> AppTestAuthResponse

CRM

Types:

from retell.types import (
    CRMConfig,
    CRMGetSchemaResponse,
    CRMGetSyncJobStatusResponse,
    CRMRunSyncJobResponse,
)

Methods:

• client.crm.get_config() -> CRMConfig
• client.crm.get_schema(**params) -> CRMGetSchemaResponse
• client.crm.get_sync_job_status() -> CRMGetSyncJobStatusResponse
• client.crm.run_sync_job() -> CRMRunSyncJobResponse
• client.crm.update_config(**params) -> CRMConfig