workflows create - Clay docs

Create a new empty workflow with the given name. The response returns the new workflow’s id, name, and a url that opens it in Clay. Add nodes and tools with the Clay app or the workflow MCP tools.

clay workflows create --name <name>

Flags

Flag	Description
`--name <name>`	Workflow name. Required. Must be non-empty and at most 255 characters.

Output

{
  "id": "wf_abc123",
  "name": "Lead enrichment",
  "url": "https://app.clay.com/..."
}

Field	Type	Description
`id`	string	Id of the new workflow.
`name`	string	Display name.
`url`	string	Link that opens the workflow in Clay.

Errors

Code	Exit	Notes
`validation_error`	2	`--name` is missing, empty, or longer than 255 characters.
`auth_forbidden`	3	The API key lacks the `terracotta:cli` scope.

Examples

clay workflows create --name "Lead enrichment"
clay workflows create --name "Lead enrichment" | jq -r '.id'
clay workflows create --name "Lead enrichment" | jq -r '.url'

​Flags

​Output

​Errors

​Examples

Flags

Output

Errors

Examples