Generate a Workflow

curl --request POST \
  --url https://operator.opus.com/api/v1/workflow/generate \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {YOUR_API_KEY}' \
  --data '{
    "prompt": "Classify an incoming support email as billing or technical, then draft a reply for the chosen category.",
    "workspaceId": "{YOUR_WORKSPACE_ID}"
  }'

import requests

url = "https://operator.opus.com/api/v1/workflow/generate"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer {YOUR_API_KEY}"
}
payload = {
    "prompt": "Classify an incoming support email as billing or technical, then draft a reply for the chosen category.",
    "workspaceId": "{YOUR_WORKSPACE_ID}"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://operator.opus.com/api/v1/workflow/generate",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer {YOUR_API_KEY}",
    },
    body: JSON.stringify({
      prompt:
        "Classify an incoming support email as billing or technical, then draft a reply for the chosen category.",
      workspaceId: "{YOUR_WORKSPACE_ID}",
    }),
  }
);

const data = await response.json();
console.log(data);

{
  "entityId": "{ENTITY_ID}",
  "workflowId": "{WORKFLOW_ID}",
  "workflowVersionId": "{WORKFLOW_VERSION_ID}",
  "runId": "{RUN_ID}",
  "status": "processing",
  "confirmed": true
}

POST

api

workflow

generate

curl --request POST \
  --url https://operator.opus.com/api/v1/workflow/generate \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {YOUR_API_KEY}' \
  --data '{
    "prompt": "Classify an incoming support email as billing or technical, then draft a reply for the chosen category.",
    "workspaceId": "{YOUR_WORKSPACE_ID}"
  }'

import requests

url = "https://operator.opus.com/api/v1/workflow/generate"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer {YOUR_API_KEY}"
}
payload = {
    "prompt": "Classify an incoming support email as billing or technical, then draft a reply for the chosen category.",
    "workspaceId": "{YOUR_WORKSPACE_ID}"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://operator.opus.com/api/v1/workflow/generate",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer {YOUR_API_KEY}",
    },
    body: JSON.stringify({
      prompt:
        "Classify an incoming support email as billing or technical, then draft a reply for the chosen category.",
      workspaceId: "{YOUR_WORKSPACE_ID}",
    }),
  }
);

const data = await response.json();
console.log(data);

{
  "entityId": "{ENTITY_ID}",
  "workflowId": "{WORKFLOW_ID}",
  "workflowVersionId": "{WORKFLOW_VERSION_ID}",
  "runId": "{RUN_ID}",
  "status": "processing",
  "confirmed": true
}

Create a workflow from a plain-language prompt entirely through the API — no browser session required. Opus AI agents design and build the workflow for you, and this endpoint returns immediately with a runId you poll until the generation finishes.

Generation is asynchronous. This endpoint creates the workflow and starts the run, then returns right away. Track progress with Get Run Status until the run reaches a terminal status.

Requires the Workflow: Full permission in the target workspace.

Body Parameters

string

required

What to build, in plain language. Be specific: the goal, the steps you already know, decisions to be made, and the systems involved.

string

required

The UUID of the workspace to create the workflow in. You must be a member of this workspace.

string

Workflow name. Defaults to the first 60 characters of the prompt.

string

Short title for the run. Generated automatically when omitted.

string[]

Uploaded file references to give the AI as context (process docs, examples, specs). Maximum of 10.

string[]

Org unit UUIDs to tag the new workflow to. Maximum of 100. Omitted or empty means no tagging.

Your organization is always taken from the API key — it cannot be set in the body.

Response

string

required

The workflow’s catalog entity ID.

string

required

The workflow ID. Use this as {workflowId} in Get Run Status and Cancel a Run.

string

required

The ID of the workflow version created for this generation.

string

required

The generation run ID. Poll it with Get Run Status.

string

required

The initial run status (e.g., processing).

boolean

Whether the run is registered and underway. false indicates the run was not confirmed in room state.

Errors

Bad Request

Invalid body (bad UUIDs, more than 10 files or 100 org units), or the API key has no active organization.

Unauthorized

Missing, invalid, or expired API key, or the key’s user is no longer a member of the organization.

Forbidden

The key’s user lacks the Workflow: Full permission in the target workspace.

Not Found

No workspace found — the workspace doesn’t exist or you don’t have access to it.

Conflict

This workflow already has a run in progress. Only one run is allowed at a time.

Too Many Requests

Too many active runs. Limits are 20 per workspace and 100 per organization. The response body carries {scope, limit, active}. Your API key’s own rate limit can also return 429.

Service Unavailable

Generation is temporarily unavailable — retry shortly.

curl --request POST \
  --url https://operator.opus.com/api/v1/workflow/generate \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {YOUR_API_KEY}' \
  --data '{
    "prompt": "Classify an incoming support email as billing or technical, then draft a reply for the chosen category.",
    "workspaceId": "{YOUR_WORKSPACE_ID}"
  }'

import requests

url = "https://operator.opus.com/api/v1/workflow/generate"
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer {YOUR_API_KEY}"
}
payload = {
    "prompt": "Classify an incoming support email as billing or technical, then draft a reply for the chosen category.",
    "workspaceId": "{YOUR_WORKSPACE_ID}"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://operator.opus.com/api/v1/workflow/generate",
  {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      "Authorization": "Bearer {YOUR_API_KEY}",
    },
    body: JSON.stringify({
      prompt:
        "Classify an incoming support email as billing or technical, then draft a reply for the chosen category.",
      workspaceId: "{YOUR_WORKSPACE_ID}",
    }),
  }
);

const data = await response.json();
console.log(data);

{
  "entityId": "{ENTITY_ID}",
  "workflowId": "{WORKFLOW_ID}",
  "workflowVersionId": "{WORKFLOW_VERSION_ID}",
  "runId": "{RUN_ID}",
  "status": "processing",
  "confirmed": true
}

⌘I

Get Started

Jobs

Workflow Generation

Generate a Workflow

Body Parameters

Response

Errors

​Body Parameters

​Response

​Errors

Body Parameters

Response

Errors