API reference · schema

RecordActionRequest

6 fields · used by 0 operations

Last reviewed 2026-11-06

Fields

Field	Type	Meaning
`envelope_id` required	string
`action` required	string
`tool`	string or null
`resource`	string or null
`intent`	string or null
`result`	string	default `"success"`

Smallest valid example

{
  "envelope_id": "envelope-id",
  "action": "action",
  "result": "success"
}

JSON Schema

Show the raw definition

{
  "properties": {
    "envelope_id": {
      "type": "string",
      "title": "Envelope Id"
    },
    "action": {
      "type": "string",
      "title": "Action"
    },
    "tool": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Tool"
    },
    "resource": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Resource"
    },
    "intent": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Intent"
    },
    "result": {
      "type": "string",
      "title": "Result",
      "default": "success"
    }
  },
  "type": "object",
  "required": [
    "envelope_id",
    "action"
  ],
  "title": "RecordActionRequest"
}

Try CAIN-42 on your own agents

Create a free account and every new account starts with a 30-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