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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Sarj AI Developer API

Sarj AI Developer API Custom Scenarios API

The custom-scenarios API from Sarj AI Developer API — 5 operation(s) for custom-scenarios.

Documentation Provider Profile APIs.io OpenAPI GitHub

Sarj AI Developer API Custom Scenarios 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 custom-scenarios. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 8 operations across 5 paths, and defines 66 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against the base URL https://platform-api.sarj.ai/api/v1.

8 operations 5 paths 66 schemas 1 DELETE1 GET4 POST2 PUT

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
Resource Areas
1

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 1 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

custom-scenarios 8
POST
/v1/beta/scenarios/list
List Scenarios
customScenariosListScenarios body → 200422
POST
/v1/beta/scenarios/by-ids
Get Scenarios By Ids
customScenariosGetScenariosByIds body → 200422
PUT
/v1/beta/scenarios/create
Create Scenario
customScenariosCreateScenario body → 200422
PUT
/v1/beta/scenarios/{scenario_id}
Ensure Scenario
customScenariosEnsureScenario 1 param body → 200422
POST
/v1/beta/scenarios/{scenario_id}
Update Scenario
customScenariosUpdateScenario 1 param body → 200422
GET
/v1/beta/scenarios/{scenario_id}
Get Scenario
customScenariosGetScenario 1 param → 200422
DELETE
/v1/beta/scenarios/{scenario_id}
Delete Scenario
customScenariosDeleteScenario 1 param → 200422
POST
/v1/beta/scenarios/{scenario_id}/transfer
Transfer Ownership
customScenariosTransferOwnership 1 param body → 200422

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are CustomApiToolParameters (12 properties), CustomScenarioSaveResponse (11 properties), TransferToHumanToolParameters (11 properties), UpsertCustomScenarioConfig (10 properties). Each schema is shown below with its type and property counts.

CustomScenarioSaveResponse
object
11 properties 7 required
KeyValueVariable
object
2 properties 2 required
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…
Schema
object
1 property 1 required
NumberVariable
object
3 properties 3 required
ScheduleCallbackToolParameters
object
Records a request to call the customer back later, during or after the call. WHEN TO USE: Only when the prompt mentions calling the customer back at a later ti…
10 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…
10 properties 2 required
ListCustomScenarioResponse
object
3 properties 1 required
ArrayVariable
object
4 properties 4 required
ZohoCRMRecordSink
object
1 property
FixedValue_Union_int__float__
object
3 properties 2 required
Instructions
object
3 properties 1 required
ValidationError
object
5 properties 3 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
FollowUpInference
object
Lets the post-call analyst propose a callback the agent never explicitly booked. WHEN TO USE: When the business wants follow-ups on calls where the customer di…
2 properties
CustomScenarioStatus
string
WeekDay
integer
ScenarioOptionalField
object
5 properties 2 required
ListCustomScenarioInput
object
5 properties
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
AgentProvidedVariable_Literal__array___
object
5 properties 4 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
FixedValue_str_
object
3 properties 2 required
DataExtractionDisabled
object
1 property
RecordingSinkSettings
object
2 properties
AdvancedDataExtractionSettings
object
1 property
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
HTTPMethod
string
UpsertCustomScenario
object
5 properties 5 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
HTTPValidationError
object
1 property
SallaCustomerFacingFunctionality
string
Enum for functionalities exposed via the integration APIs. Simplifies UI/UX and bundles required tools under a single functionality.
ConnectionSettings
object
2 properties 2 required
TimeRangeDayConfiguration
object
2 properties 2 required
WorkingHoursDisabled
object
1 property
FixedValue_list_object__
object
3 properties 2 required
BooleanVariable
object
3 properties 3 required
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
GlobalVariableField
object
3 properties 1 required
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
AgentProvidedVariable_Literal__string___
object
5 properties 4 required
ScheduleConfiguration
object
2 properties 2 required
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
KbRetrievalMode
string
ZohoCallActivitySink
object
1 property
AgentProvidedVariable_Literal__number___
object
5 properties 4 required
WorkingHoursEnabledV2
object
2 properties 1 required
StringVariable
object
3 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
ScenarioRequiredField
object
4 properties 2 required
PayloadConfiguration
object
2 properties 2 required
AgentProvidedVariable_Literal__boolean___
object
5 properties 4 required
GlobalVariable
object
2 properties 2 required
LLMInstruction
object
1 property 1 required
LanguageSettings
object
1 property 1 required
UpsertCustomScenarioConfig
object
10 properties 2 required
ScenarioVariable
object
2 properties 2 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
GetScenariosByIdsRequest
object
1 property 1 required
Language
string
Language codes in ISO 639-1
CustomScenarioRecord
object
10 properties 7 required
FixedValue_bool_
object
3 properties 2 required
TransferOwnershipRequest
object
1 property 1 required
UpdateCustomScenario
object
5 properties 1 required
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
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sarj-ai-developer-api-custom-scenarios-api-openapi.yml Raw ↑

Other APIs Sarj AI Developer API publishes across the network.

Sarj AI Developer API Agent Profiles API
AE Profile APIs.io
Sarj AI Developer API Analytics API
AE Profile APIs.io
Sarj AI Developer API Audio API
AE Profile APIs.io
Sarj AI Developer API Batch API
AE Profile APIs.io
Sarj AI Developer API Calls API
AE Profile APIs.io
Sarj AI Developer API Debug API
AE Profile APIs.io
Sarj AI Developer API Health API
AE Profile APIs.io
Sarj AI Developer API Integrations API
AE Profile APIs.io
Sarj AI Developer API Messaging API
AE Profile APIs.io
Sarj AI Developer API Metrics API
AE Profile APIs.io
Sarj AI Developer API Models API
AE Profile APIs.io
Sarj AI Developer API Openai API
AE Profile APIs.io
#custom-scenarios
← Back to S APIs
API Details
ID
sarj-ai-developer-api:sarj-ai-developer-api-custom-scenarios-api
Base URL
https://platform-api.sarj.ai/api/v1
Docs
https://platform-docs.sarj.ai
Provider
Sarj AI Developer API
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=sarj-ai-developer-api-custom-scenarios-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sarj-ai-developer-api-custom-scenarios-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Sarj AI Developer API Custom Scenarios 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.