Sarj AI Developer API Calls API
Create outbound voice calls and retrieve call details and transcripts.
Sarj AI Developer API Calls API is one of 27 APIs that Sarj AI Developer API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Calls. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.
This API exposes 12 operations across 12 paths, and defines 234 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against a single base URL, https://platform-api.sarj.ai/api/v1.
12 operations
12 paths
234 schemas
1 DELETE4 GET7 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Sarj AI Developer API Calls API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (ApiKeyAuth).
ApiKeyAuth— API key from your Sarj.ai dashboard. Pass as: Authorization: Bearer
Paths & Operations 12
Across 12 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.
Calls 12
Create outbound voice calls and retrieve call details and transcripts.
POST
/calls
Place an outbound Sarj.ai voice call
GET
/calls/{call_id}
Fetch Sarj.ai voice call details by callid
POST
/v1/beta/calls/outbound
Outbound Call
POST
/v1/beta/calls/chat
Create Chat
POST
/v1/beta/calls/client
Create Client Call
GET
/v1/beta/calls/detail/{call_id}
Get Detail
GET
/v1/beta/calls/{call_id}/transcriptions
Get Transcriptions
POST
/v1/beta/calls/{call_id}/retry-outcome
Retry Call Outcome
POST
/v1/beta/calls/count-for-org
Count For Org
POST
/v1/beta/calls/blocked-numbers
Block Number
DELETE
/v1/beta/calls/blocked-numbers/{phone_number}
Unblock Number
GET
/v1/beta/calls/phone-numbers
List Phone Numbers
Schemas 234
The contract defines 234 schemas that model the data the API accepts and returns. The most detailed are CallDetail (38 properties), Call (30 properties), PublicCallDetail (15 properties), ListCallsInput (13 properties). Each schema is shown below with its type and property counts.
OpenAITTSModels
string
StringVariable
object
3 properties
3 required
HamsaTTSDialect
string
ModelConfig
object
5 properties
4 required
EnhancedTranscriptionMessage
object
2 properties
1 required
ScenarioVariable
object
2 properties
2 required
SarjF5TTSSettings
object
2 properties
1 required
WorkingHoursDisabled
object
1 property
CallCompletedWebhookPayload
object
4 properties
1 required
SipStatus
string
CallRecording
object
3 properties
2 required
InboundCallFailure
object
3 properties
2 required
AdvancedDataExtractionSettings
object
1 property
OauthInvalidRedirectUriPayload
object
3 properties
2 required
DisableSTTFallback
object
1 property
DeleteOldTasksTickMessage
object
2 properties
ToolCallMessage
object
5 properties
3 required
ZohoCallActivityMessage
object
4 properties
2 required
CustomScenarioConfig
object
Complete configuration for a voice bot scenario. This is the FULL structure the scenario generator must produce. Output ONLY raw JSON - no markdown code blocks…
9 properties
2 required
ScenarioOptionalField
object
5 properties
2 required
BackChannelConfig
object
3 properties
CallCreationSettings
object
12 properties
7 required
Custom
object
2 properties
1 required
CallNotCompletedType
string
Task
object
11 properties
7 required
SlackAlertMessage
object
2 properties
1 required
ErrorWebhookData
object
4 properties
2 required
NoOpMessage
object
1 property
SarjCustomSTTSettings
object
1 property
1 required
PublicCallDetail
object
15 properties
3 required
FixedValue_str_
object
3 properties
2 required
HTTPMethod
string
AWSTTSSettings
object
2 properties
1 required
SarjEouTurnDetection
object
6 properties
TransferMode
string
How a transfer-to-human hands the caller over. COLD: dial the human into the caller's room and step out (current default). WARM: agent-assisted — caller on hol…
GlobalOverriddenSettings
object
2 properties
1 required
SuccessCriteriaResult
object
3 properties
3 required
PhoneNumberHistoryResponse
object
3 properties
3 required
TTSVoice
object
10 properties
9 required
StaleCallCleanupMessage
object
1 property
OpenAILLMSettings
object
3 properties
2 required
UnauthorizedPayload
object
2 properties
1 required
ApiCall
object
3 properties
2 required
CallReportsEnqueueMessage
object
1 property
CallInProgressHealthCheckMessage
object
2 properties
1 required
ScenarioNotFoundPayload
object
3 properties
2 required
BackChannelMixConfig
object
5 properties
1 required
GeminiLLMSettings
object
3 properties
1 required
GroqSTTSettings
object
2 properties
2 required
OpenAISTTSettings
object
3 properties
2 required
CallOutcomeMessage
object
3 properties
1 required
SortOrder
string
ValidationErrorPayload
object
3 properties
2 required
CustomScenario
object
4 properties
2 required
KeyValueVariable
object
2 properties
2 required
ElevenLabsSTTModel
string
Schema
object
1 property
1 required
PublicCallReport
object
2 properties
2 required
PhoneNumberBlockedPayload
object
3 properties
2 required
SallaCustomerFacingFunctionality
string
Enum for functionalities exposed via the integration APIs. Simplifies UI/UX and bundles required tools under a single functionality.
AWSSTTSettings
object
2 properties
1 required
AzureSTTSettings
object
2 properties
1 required
InteractionType
string
ScenarioForbiddenPayload
object
3 properties
2 required
DisconnectionReason
string
RegularMessage
object
4 properties
2 required
InsightCategory
string
What kind of change to the agent resolves the insight.
ZohoDeskCreateTicketToolParameters
object
Creates a support ticket in Zoho Desk for follow-up actions. WHEN TO USE: When an issue needs to be tracked or followed up by the support team. BEST PRACTICES:…
4 properties
3 required
ZohoCallActivitySink
object
1 property
CustomApiToolParameters
object
Calls a custom external API during the conversation. WHEN TO USE: When the scenario needs to fetch or send data to external systems (e.g., order lookup, bookin…
12 properties
11 required
PhoneDirection
string
CallNotCompletedWebhookPayload
object
1 property
1 required
CerebrasLLMModel
string
ZohoCRMRecordUpdateMessage
object
4 properties
2 required
BackChannelWordConfig
object
3 properties
OpenAITTSVoices
string
VoiceMigrationMessage
object
1 property
ScenarioInsight
object
8 properties
8 required
OpenAITTSSettings
object
5 properties
1 required
DeepgramTTSModel
string
CountForOrgResponse
object
2 properties
2 required
GroqLLMModel
string
LanguageSettings
object
1 property
1 required
WorkingHoursEnabledV2
object
2 properties
1 required
CodeSwitchToolParameters
object
Switches the conversation language when the user speaks a different language. WHEN TO USE: When the scenario needs to support multiple languages and gracefully…
3 properties
2 required
AgentProvidedVariable_Literal__array___
object
5 properties
4 required
ScenarioInsightAnalysisMessage
object
2 properties
1 required
ToolResultMessage
object
7 properties
4 required
CartesiaTTSSettings
object
5 properties
1 required
DisableBackChanneling
object
1 property
OutboundCallFailedPayload
object
3 properties
2 required
Call
object
30 properties
5 required
DispatchOutboundCallMessage
object
4 properties
2 required
PhoneNumberSortField
string
ValidationError
object
5 properties
3 required
CallRecordingFormat
string
HamsaTTSSettings
object
3 properties
1 required
STTTranscription
object
6 properties
6 required
AgentProvidedVariable_Literal__boolean___
object
5 properties
4 required
BatchReportGenerationMessage
object
6 properties
1 required
ClientCallResponse
object
7 properties
7 required
InboundCallSuccess
object
5 properties
5 required
DataExtractionDisabled
object
1 property
TranscriptRole
string
DataExtractionEnabled
object
Captures structured data from conversations for analytics and business intelligence. WHEN TO USE: - Client needs specific data points extracted from calls - Bu…
3 properties
1 required
LiveKitTurnDetection
object
4 properties
CountForOrgInput
object
1 property
1 required
PayloadConfiguration
object
2 properties
2 required
GoogleSTTSettings
object
3 properties
3 required
OrpheusArabicVoice
string
ZohoCRMModules
string
GlobalDefaultSettings
object
1 property
PublicTranscriptMessage
object
2 properties
2 required
STTFallbackConfig
object
2 properties
CallNotFoundPayload
object
3 properties
2 required
CerebrasLLMSettings
object
2 properties
1 required
CustomScenarioRecord
object
10 properties
7 required
SallaToolsBundleConfiguration
object
Enables Salla e-commerce platform integration for the voice agent. NOTE: Requires a functional Salla integration configured for the organization.
2 properties
2 required
CustomScenarioStatus
string
ElevenLabsSTTSettings
object
3 properties
1 required
OutboundCallInput
object
8 properties
3 required
DeleteExpiredOrgDataTickMessage
object
2 properties
IVRNavigationToolParameters
object
Enables the agent to navigate Interactive Voice Response (IVR) phone menus. This tool allows the agent to press keys (send DTMF tones) when prompted by a call…
2 properties
1 required
ElevenLabsModels
string
UpdateScenarioAgentMessage
object
4 properties
3 required
SarjF5TTSVoice
string
Transcript
object
1 property
1 required
SarjGroqSTTSettings
object
1 property
1 required
GenericSlackAlert
object
3 properties
2 required
SarjOmniTTSVoice
string
BackchannelAudioConfig
object
3 properties
1 required
TranscriptionError
object
3 properties
3 required
NotFoundPayload
object
2 properties
1 required
ElevenLabsRegion
string
CallOutcome
object
3 properties
2 required
GlobalVariableField
object
3 properties
1 required
CallData
object
12 properties
2 required
TimeoutSettings
object
3 properties
SuccessWebhookData
object
3 properties
2 required
GlobalSettings
object
7 properties
4 required
ForLanguageSettings
object
Language-specific configuration for the scenario. Each scenario must have at least one language setting. The prompt and firstmessage should be in the specified…
6 properties
3 required
SoundId
string
ApiResponse_PublicCall_
object
2 properties
1 required
DeepgramTTSSettings
object
3 properties
2 required
AzureOpenAIModel
string
CartesiaModels
string
KbRetrievalMode
string
HamsaTTSSpeaker
string
CallQueuedHealthCheckMessage
object
2 properties
1 required
ArrayVariable
object
4 properties
4 required
GlobalModelConfig
object
6 properties
5 required
STTProvider
string
Language
string
Language codes in ISO 639-1
LLMInstruction
object
1 property
1 required
ChatCallInput
object
3 properties
2 required
ScheduleConfiguration
object
2 properties
2 required
PhoneNumberHistory
object
10 properties
8 required
AgentProvidedVariable_Literal__number___
object
5 properties
4 required
Gender
string
FixedValue_list_object__
object
3 properties
2 required
OrpheusEnglishVoice
string
ProcessMessagingMessage
object
4 properties
3 required
ListCallsInput
object
13 properties
NumberFormat
string
InstructionsMessage
object
3 properties
2 required
HamsaSTTSettings
object
2 properties
1 required
SpeechmaticsSTTSettings
object
3 properties
1 required
Report
object
2 properties
1 required
ElevenLabsTTSSettings
object
7 properties
3 required
CollectDigitsToolParameters
object
Collects digits from the caller via DTMF keypad and/or spoken digit sequences. WHEN TO USE: National ID / Iqama, phone numbers, OTP codes, account numbers—any…
10 properties
3 required
ResponseMeta
object
Contains request-level metadata included with every public API response.
1 property
GroqTTSSettings
object
2 properties
2 required
CallRetryMessage
object
2 properties
1 required
SarjOmniTTSSettings
object
3 properties
1 required
ConversationExportMessage
object
6 properties
1 required
NoOrganizationPayload
object
2 properties
1 required
CallDispatchPriority
string
ScenarioGenerationMessage
object
2 properties
1 required
PublicCallOutcome
object
3 properties
3 required
BatchCallsRetryMessage
object
2 properties
1 required
AzureOpenAILLMSettings
object
2 properties
2 required
Instructions
object
3 properties
1 required
TransferToHumanToolParameters
object
Transfers the call to a human agent when the AI cannot handle the situation. WHEN TO USE: When users need human assistance for complex issues, complaints, or s…
11 properties
3 required
DeepgramSTTSettings
object
6 properties
1 required
TimeRangeDayConfiguration
object
2 properties
2 required
StartBatchCallsTickMessage
object
2 properties
SuccessCriterion
object
Defines a success criterion for evaluating call outcomes. Success criteria determine whether a call achieved its business objectives. They are used for analyti…
2 properties
1 required
GroqLLMSettings
object
2 properties
1 required
CallOutcomeStatus
string
FixedValue_bool_
object
3 properties
2 required
ErrorResponse
object
Standard envelope for all public API error responses. error is a discriminated union — branch on error.type to access variant-specific fields. Clients MUST tre…
2 properties
1 required
ScenarioInvalidConfigPayload
object
3 properties
2 required
ApiResponse_PublicCallDetail_
object
2 properties
1 required
CallDetail
object
38 properties
6 required
NumberVariable
object
3 properties
3 required
BackChannelSoundConfig
object
3 properties
1 required
TaskStatus
string
PostCallTranscript
object
2 properties
2 required
DeepgramSTTModel
string
DisableTurnDetection
object
1 property
HTTPValidationError
object
1 property
ScenarioRequiredField
object
4 properties
2 required
CallLimitExceededPayload
object
4 properties
3 required
ConnectionSettings
object
2 properties
2 required
GroqSTTModels
string
ZohoCRMRecordSink
object
1 property
CreateCallRequest
object
4 properties
2 required
RecordingSinkSettings
object
2 properties
SipCall
object
1 property
BlockNumberInput
object
1 property
1 required
CallStatus
string
WeekDay
integer
ReportColumn
object
2 properties
2 required
ScenarioSettingsOverride
object
1 property
DisableTimeoutSettings
object
1 property
PublicSuccessCriteriaResult
object
3 properties
3 required
FieldViolation
object
2 properties
2 required
AgentProvidedVariable_Literal__string___
object
5 properties
4 required
PublicCall
object
5 properties
5 required
ClientCallInput
object
5 properties
2 required
BooleanVariable
object
3 properties
3 required
CreateBatchCallsMessage
object
2 properties
1 required
FixedValue_Union_int__float__
object
3 properties
2 required
TaskType
string
CallSubject
object
4 properties
2 required
GlobalVariable
object
2 properties
2 required
EndCallToolParameters
object
Ends the call gracefully when the conversation objective is complete. WHEN TO USE: Every scenario MUST include this tool to define how calls end. BEST PRACTICE…
3 properties
2 required
InternalErrorPayload
object
2 properties
1 required
AzureTTSSettings
object
3 properties
1 required
OpenAIModel
string
OutboundDispatchTickMessage
object
2 properties
CreateDefaultAgentsMessage
object
1 property
VoicemailDetectionToolParameters
object
Detects when the call has reached a voicemail or answering machine and responds appropriately. WHEN TO USE: Include in outbound call scenarios where the agent…
3 properties
1 required
WebhookNotificationMessage
object
2 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Sarj AI Developer API 12
Other APIs Sarj AI Developer API publishes across the network.
Sarj AI Developer API Admin API
Sarj AI Developer API Agent Profiles API
Sarj AI Developer API Analytics API
Sarj AI Developer API Audio API
Sarj AI Developer API Batch API
Sarj AI Developer API Debug API
Sarj AI Developer API Health API
Sarj AI Developer API Integrations API
Sarj AI Developer API Messaging API
Sarj AI Developer API Metrics API
Sarj AI Developer API Models API
Sarj AI Developer API Openai API
#Calls
Where this information came from
This is an independent, third-party profile of Sarj AI Developer API Calls API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.