Roark · Schema
UpdateCustomerFlowInput
Fields to change on a customer flow. The step graph is edited through PUT /graph instead.
CompanyVoice AITestingEvaluationBenchmarking
Properties
| Name | Type | Description |
|---|---|---|
| title | string | |
| description | stringnull | |
| scriptAdherence | string | Scripted flows only. How closely a run follows the script. LOOSE (default) hands the whole script to the simulated customer as one prompt; it keeps the call moving whatever your agent says. STRICT run |
| offScriptPolicy | object | |
| branchingMode | string | Scripted flows only. How a run walks the graph. DETERMINISTIC ("Simulate every path" in the app) places one call per variant, each following its path exactly whatever the agent says. ADAPTIVE ("Adapt |
| agentIds | array | Replaces the linked agents. Omit to leave them unchanged. An improv flow must keep at least one; a scripted flow can be left with none. |
| agentExpectations | array | Replaces the flow-level expectations. Omit to leave them unchanged. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/roark/json-schema/roark-update-customer-flow-input-schema.json",
"title": "UpdateCustomerFlowInput",
"description": "Fields to change on a customer flow. The step graph is edited through PUT /graph instead.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/roark-customer-flow-api-openapi.yml#/components/schemas/UpdateCustomerFlowInput",
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1
},
"description": {
"type": [
"string",
"null"
]
},
"scriptAdherence": {
"type": "string",
"enum": [
"LOOSE",
"STRICT"
],
"description": "Scripted flows only. How closely a run follows the script. LOOSE (default) hands the whole script to the simulated customer as one prompt; it keeps the call moving whatever your agent says. STRICT runs the script as a state machine on the agent service: at every agent step the simulated customer waits, silent, until your agent has said the expected line, and only then moves on. Scripted flows only; STRICT needs the agent-service transport and is not available on realtime models."
},
"offScriptPolicy": {
"oneOf": [
{
"$ref": "#/$defs/OffScriptPolicy"
},
{
"type": "null"
}
]
},
"branchingMode": {
"type": "string",
"enum": [
"DETERMINISTIC",
"ADAPTIVE"
],
"description": "Scripted flows only. How a run walks the graph. DETERMINISTIC (\"Simulate every path\" in the app) places one call per variant, each following its path exactly whatever the agent says. ADAPTIVE (\"Adapt to your agent\") collapses the paths into one call PER PERSONA, on which the simulated customer picks a branch from what the agent actually said. Both modes speak the exact authored lines, and neither changes how metrics or expectations grade."
},
"agentIds": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "Replaces the linked agents. Omit to leave them unchanged. An improv flow must keep at least one; a scripted flow can be left with none."
},
"agentExpectations": {
"type": "array",
"items": {
"$ref": "#/$defs/FlowExpectationInput"
},
"description": "Replaces the flow-level expectations. Omit to leave them unchanged."
}
},
"$defs": {
"FlowExpectationInput": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"minLength": 1,
"description": "What the agent under test is graded against."
}
},
"required": [
"prompt"
]
},
"OffScriptPolicy": {
"type": "object",
"properties": {
"reaction": {
"type": "string",
"enum": [
"STAY_SILENT",
"REPEAT",
"RESPOND",
"SAY"
],
"default": "STAY_SILENT"
},
"sayLine": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 2000
},
"maxAttempts": {
"type": "integer",
"minimum": 1,
"maximum": 20,
"default": 3
},
"then": {
"type": "string",
"enum": [
"HANG_UP",
"MOVE_ON",
"ADAPT",
"HANG_UP_INVALIDATE"
],
"default": "HANG_UP"
},
"waitSeconds": {
"type": [
"integer",
"null"
],
"minimum": 1,
"maximum": 600
}
},
"required": [
"reaction",
"maxAttempts",
"then"
],
"description": "STRICT only. What the simulated customer does when your agent does not say the expected line. Each unmatched agent utterance is an attempt: `reaction` runs per attempt (STAY_SILENT, REPEAT its last scripted line, RESPOND once in character without moving on, or SAY `sayLine`), and `then` runs when attempts reach `maxAttempts` or your agent stays silent for `waitSeconds` (HANG_UP ends the call with ended reason SCRIPT_DIVERGED, HANG_UP_INVALIDATE ends it the same way and invalidates the run so it is scored by nothing and counted nowhere, MOVE_ON advances anyway, ADAPT hands the rest of the call to loose behaviour). Null: stay silent, 3 attempts, hang up. The default for every agent step; an AGENT_TURN step can carry its own."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/roark-update-customer-flow-input"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.