MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Workflows

Create a workflow

Create a workflow with a draft. Without `graph`, the draft holds one `trigger` node, ready for `editWorkflow` ops. Pass `graph` only to start from a complete graph. The response carries the `revision` you need to edit.

Workflow builder. Included from the Jump Starter plan. See plans.

POST/workflows
Query parameters
user_idinteger

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. [How acting for a client works](/docs/reseller/your-clients/acting-as-clients).

Body
2 fields
·

A non-empty name.

A complete graph to start a workflow from, in the same shape getWorkflow returns under draft. A workflow you read can be sent back as a new one. It is built with the same checks as editWorkflow ops. Most callers skip it and build with editWorkflow instead.

Nodes*
No items yet.
Edges*
No items yet.
curl -X POST 'https://omnidim.io/api/v1/workflows' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example response
synthetic
{
  "workflow": {
    "id": 0,
    "name": "string",
    "status": "draft",
    "published_version_id": 0,
    "webhook_url": "string",
    "draft": {
      "version_id": 0,
      "revision": "string",
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "label": "string",
          "position": {
            "x": 0,
            "y": 0
          },
          "config": "string"
        }
      ],
      "edges": [
        {
          "from": "string",
          "to": "string",
          "handle": "string"
        }
      ]
    }
  },
  "issues": {
    "errors": [
      {
        "code": "string",
        "message": "string",
        "node": "string",
        "field": "string",
        "hint": "string"
      }
    ],
    "warnings": [
      {
        "code": "string",
        "message": "string",
        "node": "string",
        "field": "string",
        "hint": "string"
      }
    ]
  }
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Query Parameters

user_id?integer

Reseller keys only: act as one of your clients by its user id. Omit it to act on your own account. How acting for a client works.

Request Body

application/json
name*string

A non-empty name.

graph?

A complete graph to start a workflow from, in the same shape getWorkflow returns under draft. A workflow you read can be sent back as a new one. It is built with the same checks as editWorkflow ops. Most callers skip it and build with editWorkflow instead.

Response body

application/json

Response Body

The workflow was created.

application/json
workflow?
issues?

What validation found. Errors block publish. Warnings do not.

Was this page helpful?

List workflows

Your workflows, oldest first, one cursor page at a time. Use it to find a workflow id. Pass back `next_cursor` until it is `null`.

Get a workflow

One workflow with its draft, status and `revision`. Call it before every edit to get the current `revision`. Use `view=structure` to see nodes and edges without config on a large workflow. Secrets read back as `********`.