CallScriptsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/elocuenti-com/json-schema/elocuenti-com-call-scripts-response-schema.json",
  "title": "CallScriptsResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/elocuenti-com-calls-api-openapi.yml#/components/schemas/CallScriptsResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/CallScript"
      },
      "title": "Data"
    },
    "request_id": {
      "type": "string",
      "description": "The identifier of this request. Give it to support if you need help.",
      "title": "Request Id"
    }
  },
  "required": [
    "data",
    "request_id"
  ],
  "$defs": {
    "CallScript": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The identifier of the script. Send it as `purpose_id` when you place a call.",
          "title": "Id"
        },
        "name": {
          "type": "string",
          "description": "The name of the script, as your team sees it in the dashboard.",
          "title": "Name"
        },
        "instructions": {
          "type": "string",
          "description": "What the AI agent is told to do in the call. Placeholders look like `{{name|fallback}}`.",
          "title": "Instructions"
        },
        "variables": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "description": "The name to send in `variables`.",
                "title": "Name"
              },
              "fallback": {
                "type": "string",
                "description": "What the agent says when you do not send a value.",
                "title": "Fallback"
              }
            },
            "required": [
              "name",
              "fallback"
            ]
          },
          "description": "The values you can send for this script. `nombre`, the contact's name, is never listed: it is filled in for you.",
          "title": "Variables"
        }
      },
      "required": [
        "id",
        "name",
        "instructions",
        "variables"
      ],
      "description": "A call script of your business.",
      "title": "CallScript"
    }
  }
}