Sarj AI Developer API Scenario Generation 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 scenario-generation. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.
This API exposes
6 operations
across 5 paths,
and defines 75 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.
The identity and technical contract details declared by the specification.
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…
GenerationErrorCode
string
VerificationNeededSuggestion
object
Action Required: Placeholder values that need user verification. Shows in "Action Required" section (orange, NOT dismissable). CRITICAL - WHEN TO USE: - ONLY f…
10 properties
3 required
Schema
object
1 property
1 required
GenerateScenarioRequest
object
2 properties
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
ActionUrl
string
Valid action URLs for suggestions that link to external pages. VALID VALUES (external pages only): - /knowledge-bases - Create/manage knowledge bases - /integr…
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
GenerateScenarioResponse
object
2 properties
2 required
AssumptionMadeSuggestion
object
AI Decisions: Inform user about assumptions the LLM made. Shows in "AI Decisions" section (purple, dismissable). USE WHEN LLM filled in details not explicitly…
5 properties
3 required
ScenarioOptionalField
object
5 properties
2 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
GenerationInput
object
2 properties
1 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
SuggestionMetadataResponse
object
6 properties
6 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
HTTPValidationError
object
1 property
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
GenerationSuccessOutput
object
6 properties
4 required
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
GenerationStatusResponse
object
2 properties
2 required
FixedValue_list_object__
object
3 properties
2 required
GenerationErrorOutput
object
4 properties
3 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
ScenarioGenerationLog
object
8 properties
5 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
SuggestionType
string
Types of suggestions to help users refine generated scenarios. DO NOT SUGGEST (obvious or already visible): - Tool configurations visible in form - Standard de…
ZohoCallActivitySink
object
1 property
AgentProvidedVariable_Literal__number___
object
5 properties
4 required
ResourceLinkingSuggestion
object
Opportunities: LLM-suggested enhancements the user did NOT ask for. Shows in "Opportunities" section (green, dismissable). USE WHEN external resource creation…
7 properties
3 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
FixType
string
Types of fix actions for verificationneeded suggestions. - phone, text: Support inline editing in sidebar - timerange, boolean, link: Click to scroll to actual…
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
LinkScenarioRequest
object
1 property
1 required
LanguageSettings
object
1 property
1 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
Language
string
Language codes in ISO 639-1
FixedValue_bool_
object
3 properties
2 required
SuggestionSection
string
Form sections that a suggestion can relate to. IMPORTANT: Use the EXACT string values below - no variations! - firstmessage - First message/greeting configurat…
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Sarj AI Developer API publishes across the network.
