How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 49 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 20 operations across 20 paths, and defines 199 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: /api/v1, https://platform-api.sarj.ai/api/v1.

20 operations 20 paths 199 schemas 1 DELETE7 GET12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://platform-api.sarj.ai/api/v1
Authentication
HTTP Bearer
Resource Areas
1

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 20

Across 20 paths, the API surfaces 20 operations — 1 DELETE, 7 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.

Calls 20

Create outbound voice calls and retrieve call details and transcripts.

POST
/calls
Place an outbound Sarj.ai voice call
createCall body → 202400401403404422429
POST
/calls/{call_id}/cancel
Cancel a pending scheduled Sarj.ai call
cancelScheduledCall 1 param → 200401403404409
POST
/calls/{call_id}/reschedule
Move a pending scheduled Sarj.ai call to a new time
rescheduleScheduledCall 1 param body → 200401403404409422
GET
/calls/{call_id}
Fetch Sarj.ai voice call details by callid
getCall 1 param → 200401403404
GET
/calls/{call_id}/recording
Redirect to a fresh download URL for a Sarj.ai call recording
getCallRecording 3 params → 302401403404
POST
/v1/beta/calls/inbound-call
Create Inbound Call
callsCreateInboundCall body → 200422
POST
/v1/beta/calls/outbound
Outbound Call
callsOutboundCall body → 200400403404429422
POST
/v1/beta/calls/chat
Create Chat
callsCreateChat body → 200422
POST
/v1/beta/calls/client
Create Client Call
callsCreateClientCall body → 200400403404429422
POST
/v1/beta/calls/list
List Calls
callsListCalls body → 200422
GET
/v1/beta/calls/scheduled
List Scheduled Calls
callsListScheduledCalls 8 params → 200422
GET
/v1/beta/calls/detail/{call_id}
Get Detail
callsGetDetail 1 param → 200422
GET
/v1/beta/calls/{call_id}/attempts
List Retry Attempts
callsListRetryAttempts 1 param → 200403404422
POST
/v1/beta/calls/{call_id}/retry-outcome
Retry Call Outcome
callsRetryCallOutcome 1 param → 200422
POST
/v1/beta/calls/count-for-org
Count For Org
callsCountForOrg body → 200422
POST
/v1/beta/calls/export
Export Conversations
callsExportConversations body → 200422
POST
/v1/beta/calls/blocked-numbers
Block Number
callsBlockNumber body → 200422
DELETE
/v1/beta/calls/blocked-numbers/{phone_number}
Unblock Number
callsUnblockNumber 1 param → 200422
GET
/v1/beta/calls/phone-numbers
List Phone Numbers
callsListPhoneNumbers 8 params → 200422
GET
/v1/beta/calls/{call_id}/transcriptions
Get Transcriptions
callsGetTranscriptions 1 param → 200422

Schemas 199

The contract defines 199 schemas that model the data the API accepts and returns. The most detailed are CallDetail (46 properties), Call (38 properties), PublicCallDetail (21 properties), ExportConversationsInput (17 properties). Each schema is shown below with its type and property counts.

OauthInvalidRedirectUriPayload
object
3 properties 2 required
ValidationErrorPayload
object
3 properties 2 required
PhoneDirection
string
FieldViolation
object
2 properties 2 required
ApiResponse_PublicCallDetail_
object
2 properties 1 required
RescheduleCallRequest
object
1 property 1 required
InvalidScheduleTimePayload
object
2 properties 1 required
ScenarioInvalidConfigPayload
object
3 properties 2 required
PublicTranscriptMessage
object
2 properties 2 required
PhoneNumberBlockedPayload
object
3 properties 2 required
OutboundCallFailedPayload
object
3 properties 2 required
CallStatus
string
ScenarioForbiddenPayload
object
3 properties 2 required
PublicCallReport
object
2 properties 2 required
CallNotFoundPayload
object
3 properties 2 required
NotFoundPayload
object
2 properties 1 required
UnauthorizedPayload
object
2 properties 1 required
ApiResponse_PublicCall_
object
2 properties 1 required
SchedulingDisabledPayload
object
2 properties 1 required
PublicCall
object
7 properties 5 required
ScenarioNotFoundPayload
object
3 properties 2 required
InternalErrorPayload
object
2 properties 1 required
NoOrganizationPayload
object
2 properties 1 required
PublicCallOutcome
object
3 properties 3 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
PublicSuccessCriteriaResult
object
3 properties 3 required
ResponseMeta
object
Contains request-level metadata included with every public API response.
1 property
CallNotPendingPayload
object
3 properties 2 required
CallLimitExceededPayload
object
4 properties 3 required
Language
string
Language codes in ISO 639-1
ScheduleConfigNotFoundPayload
object
3 properties 2 required
CreateCallRequest
object
6 properties 2 required
PublicCallDetail
object
21 properties 3 required
CallRecordingFormat
string
SipStatus
string
ListScheduledCallsResponse
object
2 properties 2 required
GroqSTTSettings
object
2 properties 2 required
CallQueuedHealthCheckMessage
object
2 properties 1 required
PhoneNumberHistoryResponse
object
3 properties 3 required
ErrorWebhookData
object
4 properties 2 required
OutboundCallInput
object
8 properties 3 required
ProcessMessagingMessage
object
4 properties 3 required
OrpheusArabicVoice
string
GlobalDefaultSettings
object
1 property
ElevenLabsSTTSettings
object
3 properties 1 required
CallRetryMessage
object
2 properties 1 required
NumberFormat
string
OutboundDispatchTickMessage
object
2 properties
GlobalSettings
object
7 properties 4 required
RetryKind
string
Which release lane a due retry uses (LAT-170); null on non-retries.
AWSSTTSettings
object
2 properties 1 required
SlackAlertMessage
object
2 properties 1 required
Call
object
38 properties 5 required
OpenAITTSModels
string
InstructionsMessage
object
3 properties 2 required
ScenarioInsight
object
8 properties 8 required
CallRecording
object
3 properties 2 required
GlobalModelConfig
object
6 properties 5 required
OpenAITTSSettings
object
5 properties 1 required
ScheduledCallListItem
object
One scheduled-view row. createdat is when the promise was booked, not dial time.
11 properties 11 required
EnhancedTranscriptionMessage
object
2 properties 1 required
CustomScenario
object
4 properties 2 required
LiveKitTurnDetection
object
4 properties
CallbackOrigin
string
GlobalOverriddenSettings
object
2 properties 1 required
CreateBatchCallsMessage
object
2 properties 1 required
ClientCallResponse
object
7 properties 7 required
CallCreationSettings
object
12 properties 7 required
ZohoCallActivityMessage
object
4 properties 2 required
CallDispatchPriority
string
SipCall
object
1 property
ListCallsResponse
object
4 properties 1 required
OpenAIModel
string
OrpheusEnglishVoice
string
ElevenLabsSTTModel
string
TaskStatus
string
InboundCallFailure
object
3 properties 2 required
DisableTurnDetection
object
1 property
GroqLLMModel
string
CallCompletedWebhookPayload
object
7 properties 1 required
CallUsage
object
Cumulative per-call model usage, persisted to the call.metrics JSONB column. Provider and model names live on modelsettings; this carries only the volatile per…
8 properties
BatchReportGenerationMessage
object
6 properties 1 required
CallNotCompletedType
string
HamsaTTSSettings
object
3 properties 1 required
DisableBackChanneling
object
1 property
CallData
object
13 properties 2 required
SoundId
string
Transcript
object
1 property 1 required
DisconnectionReason
string
RetryAttempt
object
One dial of a retry group, or its still-pending booking; the call drawer's attempt trail.
7 properties 7 required
SarjEouTurnDetection
object
6 properties
DispatchOutboundCallMessage
object
4 properties 2 required
AzureOpenAILLMSettings
object
2 properties 2 required
ListCallsInput
object
14 properties
SuccessWebhookData
object
3 properties 2 required
BackChannelConfig
object
3 properties
OpenAILLMSettings
object
4 properties 2 required
CountForOrgInput
object
1 property 1 required
DeleteExpiredOrgDataTickMessage
object
2 properties
InboundCallSuccess
object
5 properties 5 required
RegularMessage
object
4 properties 2 required
GroqTTSSettings
object
2 properties 2 required
ToolCallMessage
object
5 properties 3 required
CallbackVerdict
object
The post-call analyst's verdict on whether this call needs a callback.
5 properties 5 required
TranscriptRole
string
BlockNumberInput
object
1 property 1 required
VoiceMigrationMessage
object
1 property
Custom
object
2 properties 1 required
BackChannelSoundConfig
object
3 properties 1 required
SuccessCriteriaResult
object
3 properties 3 required
ScenarioGenerationMessage
object
2 properties 1 required
STTProvider
string
GroqSTTModels
string
ToolResultMessage
object
7 properties 4 required
TTSVoice
object
10 properties 9 required
ConversationExportMessage
object
6 properties 1 required
HamsaTTSSpeaker
string
TranscriptionError
object
3 properties 3 required
DeepgramTTSSettings
object
3 properties 2 required
CerebrasLLMModel
string
Task
object
11 properties 7 required
ScenarioInsightAnalysisMessage
object
2 properties 1 required
CallReportsEnqueueMessage
object
1 property
CallInProgressHealthCheckMessage
object
2 properties 1 required
SarjCustomSTTSettings
object
1 property 1 required
InboundCallInput
object
3 properties 2 required
DeepgramTTSModel
string
ElevenLabsTTSSettings
object
7 properties 3 required
AzureTTSSettings
object
3 properties 1 required
CallNotCompletedWebhookPayload
object
4 properties 1 required
HamsaTTSDialect
string
StaleCallCleanupMessage
object
1 property
DisableSTTFallback
object
1 property
UpdateScenarioAgentMessage
object
4 properties 3 required
ModelConfig
object
7 properties 4 required
ValidationError
object
5 properties 3 required
CallSource
string
Which feature placed an outbound call (LAT-181). Outbound-feature provenance only: inbound and chat rows keep call.source NULL by design. App-side validation o…
ZohoCRMRecordUpdateMessage
object
4 properties 2 required
CallDetail
object
46 properties 6 required
InteractionType
string
CartesiaModels
string
HTTPValidationError
object
1 property
Report
object
3 properties 1 required
BatchCallsRetryMessage
object
2 properties 1 required
ErrorDetail
object
The {"detail": ...} body FastAPI's default HTTPException handler serializes.
1 property 1 required
SarjGroqSTTSettings
object
1 property 1 required
ClientCallInput
object
5 properties 2 required
OpenAITTSVoices
string
SortOrder
string
HamsaSTTSettings
object
2 properties 1 required
PhoneNumberHistory
object
10 properties 8 required
CallOutcomeStatus
string
NoOpMessage
object
1 property
ScenarioSettingsOverride
object
1 property
OpenAIServiceTier
string
PhoneNumberSortField
string
ReportColumn
object
2 properties 2 required
AWSTTSSettings
object
2 properties 1 required
Gender
string
CartesiaTTSSettings
object
5 properties 1 required
WebhookNotificationMessage
object
2 properties 1 required
TurnDetectionRecord
object
Runtime turn-detection resolution persisted per call (PROD-458). type is the path that actually ran (sarjeou / livekitv1mini / vad / stt); configured is the co…
5 properties 2 required
SpeechmaticsSTTSettings
object
3 properties 1 required
ElevenLabsRegion
string
DisableTimeoutSettings
object
1 property
GenericSlackAlert
object
3 properties 2 required
BackChannelMixConfig
object
5 properties 1 required
AzureOpenAIModel
string
ChatCallInput
object
3 properties 2 required
BackChannelWordConfig
object
3 properties
ApiCall
object
3 properties 2 required
ElevenLabsModels
string
STTFallbackConfig
object
2 properties
SarjOmniTTSSettings
object
3 properties 1 required
CallOutcome
object
3 properties 2 required
StartBatchCallsTickMessage
object
2 properties
GeminiLLMSettings
object
3 properties 1 required
CerebrasLLMSettings
object
2 properties 1 required
AzureSTTSettings
object
2 properties 1 required
ExportConversationsInput
object
17 properties
InsightCategory
string
What kind of change to the agent resolves the insight.
OpenAISTTSettings
object
3 properties 2 required
CountForOrgResponse
object
2 properties 2 required
PostCallTranscript
object
2 properties 2 required
GroqLLMSettings
object
2 properties 1 required
DeepgramSTTSettings
object
6 properties 1 required
TimeoutSettings
object
3 properties
DeepgramSTTModel
string
CreateDefaultAgentsMessage
object
1 property
ScheduledCallCursor
object
Keyset cursor: the (scheduledat, id) of the last row of the previous page.
2 properties 2 required
BackchannelAudioConfig
object
3 properties 1 required
CallSubject
object
4 properties 2 required
GoogleSTTSettings
object
3 properties 3 required
CallOutcomeMessage
object
3 properties 1 required
DeleteOldTasksTickMessage
object
2 properties
TaskType
string
SarjF5TTSVoice
string
SarjF5TTSSettings
object
2 properties 1 required
STTTranscription
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sarj-ai-developer-api-calls-api-openapi.yml Raw ↑

Other APIs Sarj AI Developer API publishes across the network.

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
Sarj AI Developer API Organization Sip API
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.