Cumulus TalosDocs
Open Talos
On this page

actions.list

List the action descriptors available to publications

Request

GET /api/v1/actions

  • MCP: actions_list
  • SDK: client.actions.list (SDK path arguments use path; MCP uses params).
  • Minimum API key role: viewer.
  • Idempotency: none.

Use the request schema below. Read IDs from earlier operation results.

Input schema

json
{
  "parameters": [
    {
      "name": "channel",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "cloud",
          "phone",
          "web",
          "control"
        ]
      }
    },
    {
      "name": "invocation",
      "in": "query",
      "required": false,
      "schema": {
        "type": "string",
        "enum": [
          "model_tool",
          "flow_node",
          "setting",
          "lifecycle",
          "command"
        ]
      }
    }
  ],
  "requestBody": null
}

Responses

json
{
  "200": {
    "description": "List the action descriptors available to publications",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ActionsListResponse200"
        }
      }
    }
  },
  "4XX": {
    "description": "Typed error (ApiError)",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  },
  "5XX": {
    "description": "Typed error (ApiError)",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

Referenced schemas

json
{
  "components": {
    "schemas": {
      "ActionsListResponse200": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/ActionDescriptor"
        }
      },
      "ActionDescriptor": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]*(\\.[a-z][a-z0-9_]*)+$"
          },
          "version": {
            "type": "integer",
            "exclusiveMinimum": true,
            "minimum": 0
          },
          "kind": {
            "type": "string",
            "enum": [
              "builtin",
              "customer_http",
              "command"
            ]
          },
          "title": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "channels": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "cloud",
                "phone",
                "web",
                "control"
              ]
            },
            "minItems": 1
          },
          "invocation": {
            "type": "string",
            "enum": [
              "model_tool",
              "flow_node",
              "setting",
              "lifecycle",
              "command"
            ]
          },
          "permission": {
            "type": "string",
            "enum": [
              "tenant:read",
              "tenant:write",
              "tenant:admin",
              "platform:admin",
              "tenant:act-as",
              "tenant:dial"
            ]
          },
          "grant_action": {
            "type": "string",
            "enum": [
              "rag.index",
              "benchmark.run",
              "comparison.run",
              "gpu.manage",
              "run.execute",
              "trigger.execute",
              "test.run"
            ],
            "nullable": true
          },
          "risk": {
            "type": "string",
            "enum": [
              "low",
              "medium",
              "high"
            ]
          },
          "human_required": {
            "type": "boolean"
          },
          "effect": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "none",
                  "transaction",
                  "gateway_inference",
                  "http",
                  "livekit",
                  "sip_dial",
                  "sip_transfer",
                  "sip_hangup",
                  "run_admission",
                  "gpu"
                ]
              },
              "idempotency": {
                "type": "string",
                "enum": [
                  "owner_key",
                  "receiver_key",
                  "observe_then_act",
                  "none"
                ]
              },
              "unknown_outcome": {
                "type": "string",
                "enum": [
                  "surface_uncertain",
                  "retry_same_key",
                  "reconcile_by_observation"
                ]
              },
              "max_send_attempts": {
                "type": "integer",
                "minimum": 1,
                "maximum": 12
              },
              "timeout_ms": {
                "type": "integer",
                "minimum": 100,
                "maximum": 120000
              }
            },
            "required": [
              "kind",
              "idempotency",
              "unknown_outcome",
              "max_send_attempts",
              "timeout_ms"
            ],
            "additionalProperties": false
          },
          "input_schema": {
            "type": "object",
            "additionalProperties": {}
          },
          "output_schema": {
            "type": "object",
            "additionalProperties": {}
          },
          "config_schema": {
            "type": "object",
            "additionalProperties": {}
          }
        },
        "required": [
          "id",
          "version",
          "kind",
          "title",
          "channels",
          "invocation",
          "permission",
          "grant_action",
          "risk",
          "human_required",
          "effect",
          "input_schema",
          "output_schema",
          "config_schema"
        ],
        "additionalProperties": false
      },
      "ApiError": {
        "type": "object",
        "properties": {
          "error": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string",
                "enum": [
                  "unauthenticated",
                  "forbidden",
                  "not_found",
                  "conflict",
                  "invalid_request",
                  "idempotency_conflict",
                  "policy_denied",
                  "capability_unavailable",
                  "provider_unavailable",
                  "knowledge_unavailable",
                  "publication_invalid",
                  "run_not_active",
                  "rate_limited",
                  "outcome_unknown",
                  "internal"
                ]
              },
              "message": {
                "type": "string"
              },
              "retryable": {
                "type": "boolean"
              },
              "outcome": {
                "type": "string",
                "enum": [
                  "none",
                  "unknown"
                ]
              },
              "details": {
                "type": "object",
                "additionalProperties": {}
              }
            },
            "required": [
              "code",
              "message",
              "retryable",
              "outcome"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "error"
        ],
        "additionalProperties": false
      }
    }
  }
}

Errors and recovery

See API error handling and Troubleshooting.

Content version 3ca41f75Markdown source
actions.list · Cumulus Talos docs