CAIN-42 CAIN Studio

API reference · schema

CallRequest

7 fields · used by 1 operations

Last reviewed 2026-10-02

Fields

FieldTypeMeaning
credential requiredstringmin length 1 · max length 63
methodstringdefault "GET"
url requiredstringmin length 8 · max length 4000
headersmap of string to string
jsonany or null
bodystring or nullmax length 1000000
agent_idstring or nullmax length 200

Smallest valid example

{
  "credential": "credential",
  "method": "GET",
  "url": "url"
}

Used by 1 operation

POST/fabric/broker/callCAIN decides on the call, then makes it with the stored credential

JSON Schema

Show the raw definition
{
  "properties": {
    "credential": {
      "type": "string",
      "maxLength": 63,
      "minLength": 1,
      "title": "Credential"
    },
    "method": {
      "type": "string",
      "title": "Method",
      "default": "GET"
    },
    "url": {
      "type": "string",
      "maxLength": 4000,
      "minLength": 8,
      "title": "Url"
    },
    "headers": {
      "additionalProperties": {
        "type": "string"
      },
      "type": "object",
      "title": "Headers"
    },
    "json": {
      "anyOf": [
        {},
        {
          "type": "null"
        }
      ],
      "title": "Json"
    },
    "body": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 1000000
        },
        {
          "type": "null"
        }
      ],
      "title": "Body"
    },
    "agent_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200
        },
        {
          "type": "null"
        }
      ],
      "title": "Agent Id"
    }
  },
  "type": "object",
  "required": [
    "credential",
    "url"
  ],
  "title": "CallRequest"
}

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 7-day trial of the full platform. Or try the sandbox first, with no account at all.

Create a free account →  ·  Try the sandbox  ·  See the whole ecosystem