Create a workflow

/v1/workflows

The same row Studio and the MCP tools show. yaml is validated against the CNL schema and the kind lint before anything is stored (a bot on a frozen runtime such as harness-agent with posture is refused). folder names an existing folder or creates it. A kind: campaign create with campaign_config also sets up the ledger and the schedule. Save as YAML: send the pure workflow YAML as a text/yaml body and the metadata as the kind (required), name (required unless workflow.name is in the YAML), description and folder query parameters; a YAML body without kind is 400 invalid_request, and campaign_config stays JSON-only.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Query parameters

kindenum<string>

text/yaml body only. Required on create; on PATCH it must equal the stored kind or be left out (400 invalid_request otherwise; change a kind with a JSON PATCH)

Available options: workflow, agent, bot, campaign

namestring

text/yaml body only. Create: required unless workflow.name is in the YAML (the query wins when both are set). PATCH: renames

Maximum string length: 200

descriptionstring

text/yaml body only. Optional

folderstring

text/yaml body only. Optional; the same as the JSON folder field

Maximum string length: 120

Body

application/json
text/yaml

namestringrequired

Maximum string length: 200

kindenum<string>required

Available options: workflow, agent, bot, campaign

yamlstringrequired

The workflow as CNL YAML

descriptionstring

folderstring

Maximum string length: 120

campaign_configobject

kind campaign only (422 on any other kind). list (exactly one of table | agent | csv | inline), cycle (once | hourly | daily | weekly | monthly | continuous) and max_attempts (integer >= 1) are required; cycle_start (reset | refill), schedule (5-field cron), batch_size, max_items, pace, then (a campaign or workflow id), deliver ([{ channel, to? }], default in-app) and local are optional — the Studio campaign-config block. Invalid → 422 invalid_params, nothing is created.

formatenum<string>

Response format override (precedence: this field → Accept header → mirror of the request Content-Type). Default json. yaml = the envelope with Markdown as block scalars; markdown = the same result the MCP plane renders; text = the bare result content. An unknown value → 400 invalid_format.

Available options: json, yaml, markdown, text

Response

Saved; the Location header names the new workflow. Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

workflowobject

Show child attributes

idstring

namestring

kindenum<string>

Available options: workflow, agent, bot, campaign

descriptionstring | null

folderstring | null

The folder name, or null when unfiled

updated_atinteger

Unix seconds

versioninteger | null

Number of the current saved version; null until a version is saved

warningsstring[]

Non-fatal notes (lint warnings, campaign setup notes); present only when there are any

invalid_json / invalid_yaml / invalid_body — unreadable body; invalid_format — format must be one of json, yaml, markdown, text

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

payload_too_large — body over 1 MiB (MAX_REQUEST_SIZE)

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

invalid_workflow — the YAML failed validation or the kind lint (the envelope carries errors and warnings; nothing was written). invalid_params — a field is missing or malformed

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

storage_error — the database or storage layer failed; no detail is returned, retry

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os import requests response = requests.post( "https://api.plungeai.com/v1/workflows", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, json={ "name": "<string>", "kind": "workflow", "yaml": "<string>", }, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

const response = await fetch('https://api.plungeai.com/v1/workflows', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "name": "<string>", "kind": "workflow", "yaml": "<string>" }), }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) console.log(await response.json())

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/workflows")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"kind\":\"workflow\",\"yaml\":\"<string>\"}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

curl -X POST 'https://api.plungeai.com/v1/workflows' \ -H "Authorization: Bearer $PLUNGE_API_KEY" \ -H 'Content-Type: application/json' \ -d '{"name":"<string>","kind":"workflow","yaml":"<string>"}'

{ "workflow": { "id": "<string>", "name": "<string>", "kind": "workflow", "description": "<string>", "folder": "<string>", "updated_at": 0, "version": 0 }, "warnings": [ "<string>" ] }

Create a workflow

Authorizations

Query parameters

Body

Response

Planned: TI-33

Planned: TI-34