Roark · Schema

UpdateAgentDraftInput

CompanyVoice AITestingEvaluationBenchmarking

Properties

Name Type Description
expectedRevision integer The draft's revision when you read it. When sent, the edit is refused if the draft changed since; when omitted, it applies on top of the latest edit.
settings object The settings to change. Omitted settings stay as they are; null clears one to the runtime default. subAgents replaces every speaker and must include `main`.
View JSON Schema on GitHub

JSON Schema

roark-update-agent-draft-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/roark/json-schema/roark-update-agent-draft-input-schema.json",
  "title": "UpdateAgentDraftInput",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/roark-agent-api-openapi.yml#/components/schemas/UpdateAgentDraftInput",
  "type": "object",
  "properties": {
    "expectedRevision": {
      "type": "integer",
      "minimum": 1,
      "description": "The draft's revision when you read it. When sent, the edit is refused if the draft changed since; when omitted, it applies on top of the latest edit."
    },
    "settings": {
      "type": "object",
      "properties": {
        "modalities": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "call",
              "chat"
            ]
          },
          "maxItems": 2
        },
        "language": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 2,
          "maxLength": 10
        },
        "firstMessageMode": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "SPEAK_TEXT",
            "PLAY_AUDIO",
            "WAIT_FOR_CALLER"
          ]
        },
        "firstMessage": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "maxLength": 1000
        },
        "firstMessageAudioUrl": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "llmProvider": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "OPENAI",
            "ANTHROPIC",
            "GOOGLE",
            "XAI",
            "ULTRAVOX",
            "AWS",
            "ELEVENLABS"
          ]
        },
        "llmModel": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "maxLength": 200
        },
        "llmTemperature": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0,
          "maximum": 2
        },
        "llmMaxTokens": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 128000
        },
        "llmBackendModel": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "maxLength": 200
        },
        "llmVoice": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "maxLength": 200
        },
        "sttProvider": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "DEEPGRAM",
            "OPENAI_WHISPER",
            "SPEECHMATICS",
            "ASSEMBLYAI",
            "ELEVENLABS"
          ]
        },
        "sttModel": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "maxLength": 200
        },
        "sttKeyterms": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "maxItems": 50
        },
        "sttSmartFormat": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "sttEndpointingMs": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 10,
          "maximum": 5000
        },
        "sttTurnDetection": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "pipeline",
            "provider"
          ]
        },
        "interruptionMode": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "ALLOW",
            "BLOCK"
          ]
        },
        "vadStartSecs": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0,
          "maximum": 5
        },
        "vadStopSecs": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0,
          "maximum": 5
        },
        "callMaxDurationSeconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 30,
          "maximum": 3600
        },
        "callSilenceTimeoutSeconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 5,
          "maximum": 120
        },
        "idleTimeoutSeconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 60
        },
        "idleMaxCount": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 1,
          "maximum": 10
        },
        "idleMessages": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
          },
          "maxItems": 10
        },
        "endDetectionPhrases": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 200
          },
          "maxItems": 20
        },
        "endDetectionReasons": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1,
            "maxLength": 500
          },
          "maxItems": 20
        },
        "endCallGoodbyeMessage": {
          "type": [
            "string",
            "null"
          ],
          "minLength": 1,
          "maxLength": 500
        },
        "backgroundNoise": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "NONE",
            "AIRPORT",
            "CHILDREN_PLAYING",
            "CITY",
            "COFFEE_SHOP",
            "CONSTRUCTION",
            "CRYING_BABY",
            "DRIVING",
            "LIBRARY",
            "OFFICE",
            "THUNDERSTORM",
            "TRAIN"
          ]
        },
        "backgroundNoiseUrl": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "backgroundNoiseVolume": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0,
          "maximum": 1
        },
        "chatMaxDurationSeconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 30,
          "maximum": 86400
        },
        "chatInactivityTimeoutSeconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 60,
          "maximum": 86400
        },
        "subAgents": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "anyOf": [
                  {
                    "type": "string",
                    "const": "main"
                  },
                  {
                    "type": "string",
                    "pattern": "^[a-zA-Z0-9_-]+$",
                    "minLength": 1,
                    "maxLength": 53
                  }
                ]
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 100
              },
              "systemPrompt": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 100000
              },
              "isInitial": {
                "type": "boolean"
              },
              "ttsProvider": {
                "type": [
                  "string",
                  "null"
                ],
                "enum": [
                  "CARTESIA",
                  "ELEVENLABS",
                  "OPENAI",
                  "RIME"
                ]
              },
              "ttsModel": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 200
              },
              "ttsVoiceId": {
                "type": [
                  "string",
                  "null"
                ],
                "minLength": 1,
                "maxLength": 200
              },
              "ttsSpeed": {
                "type": [
                  "number",
                  "null"
                ],
                "minimum": 0.5,
                "maximum": 2
              },
              "ttsStability": {
                "type": [
                  "number",
                  "null"
                ],
                "minimum": 0,
                "maximum": 1
              },
              "ttsSimilarityBoost": {
                "type": [
                  "number",
                  "null"
                ],
                "minimum": 0,
                "maximum": 1
              },
              "tools": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "toolDefinitionId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "pinnedVersion": {
                      "type": [
                        "integer",
                        "null"
                      ],
                      "minimum": 1
                    }
                  },
                  "required": [
                    "toolDefinitionId",
                    "pinnedVersion"
                  ]
                },
                "maxItems": 32
              },
              "handoffs": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "to": {
                      "anyOf": [
                        {
                          "type": "string",
                          "const": "main"
                        },
                        {
                          "type": "string",
                          "pattern": "^[a-zA-Z0-9_-]+$",
                          "minLength": 1,
                          "maxLength": 53
                        }
                      ]
                    },
                    "description": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 1024
                    },
                    "once": {
                      "type": "boolean"
                    },
                    "history": {
                      "type": "string",
                      "enum": [
                        "SHARED",
                        "NONE"
                      ]
                    },
                    "note": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "minLength": 1,
                      "maxLength": 2000
                    }
                  },
                  "required": [
                    "to",
                    "description",
                    "once",
                    "history",
                    "note"
                  ]
                },
                "maxItems": 16
              }
            },
            "required": [
              "key",
              "name",
              "systemPrompt",
              "isInitial",
              "ttsProvider",
              "ttsModel",
              "ttsVoiceId",
              "ttsSpeed",
              "ttsStability",
              "ttsSimilarityBoost",
              "tools",
              "handoffs"
            ]
          },
          "minItems": 1,
          "maxItems": 17
        }
      },
      "description": "The settings to change. Omitted settings stay as they are; null clears one to the runtime default. subAgents replaces every speaker and must include `main`."
    }
  },
  "required": [
    "settings"
  ]
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/roark-update-agent-draft-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.