Skip to main content
POST
/
core.v1.WorkflowService
/
CreateWorkflowCodeFromNaturalLanguage
cURL
curl -X POST "https://api.joinformal.com/core.v1.WorkflowService/CreateWorkflowCodeFromNaturalLanguage" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "code": "<string>",
  "name": "<string>",
  "description": "<string>",
  "valid": true,
  "validationError": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.formal.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
​
naturalLanguagePrompt
string

Natural language description of the desired workflow. May include context such as existing YAML code, validation errors, or org context composed by the caller.

Required string length: 1 - 10000
​
skipRetryOnInvalid
boolean

When true, the code is still validated but the retry loop is skipped on validation failure. The response will contain accurate valid/validation_error fields regardless. Useful when the caller wants to inspect invalid code (e.g. to explain why it fails). Defaults to false (retry up to 3 times on validation failure).

Response

Success

​
code
string
​
name
string
​
description
string
​
valid
boolean
​
validationError
string