Skip to main content
POST
/
workspaces
/
{workspace_id}
/
actions
/
{action_id}
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "title": "<string>",
  "description": "<string>",
  "status": "<string>",
  "inputs": "<string>",
  "is_interactive": true,
  "ref": "<string>",
  "control_flow": {
    "run_if": "<string>",
    "for_each": "<string>",
    "join_strategy": "all",
    "retry_policy": {
      "max_attempts": 1,
      "timeout": 300,
      "retry_until": "<string>"
    },
    "start_delay": 0,
    "wait_until": "<string>",
    "environment": "<string>",
    "mask_output": false
  },
  "interaction": {
    "type": "<string>",
    "timeout": 123
  },
  "position_x": 0,
  "position_y": 0,
  "upstream_edges": [
    {
      "source_id": "<string>"
    }
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

workspace_id
string<uuid>
required
action_id
string
required

Query Parameters

workflow_id
required
Pattern: wf_[0-9a-zA-Z]+

Body

application/json
title
string | null
Required string length: 1 - 100
description
string | null
Maximum string length: 1000
status
string | null
inputs
string
default:""
Maximum string length: 300000
control_flow
ActionControlFlow · object | null
is_interactive
boolean | null
interaction
ResponseInteraction · object

An interaction configuration

position_x
number | null
position_y
number | null
upstream_edges
ActionEdge · object[] | null

Response

Successful Response

id
string<uuid>
required
type
string
required
title
string
required
description
string
required
status
string
required
inputs
string
required
is_interactive
boolean
required
ref
string
required
read-only
control_flow
ActionControlFlow · object
interaction
ResponseInteraction · object

An interaction configuration

position_x
number
default:0
position_y
number
default:0
upstream_edges
ActionEdge · object[]