Skip to main content
POST
{BASE_URL}
/
api
/
runtime
/
wks
/
{workspaceId}
/
app
/
{appId}
/
process-name
/
{processName}
/
start
curl -X POST "{BASE_URL}/api/runtime/wks/{workspaceId}/app/{appId}/process-name/{processName}/start" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "customerEmail": "alice@example.com",
    "loanAmount": 25000
  }'

Documentation Index

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

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

Looking for end-to-end guidance on calling FlowX from your own app? See Consuming FlowX from external apps.
This is the recommended entry point when you want to start a process from outside FlowX (a backend service, a scheduled job, a partner system) and you do not want to manage buildId lookups yourself. The runtime resolves the active build for the given (workspaceId, appId) pair automatically. If you need to pin to a specific build, use Start process by build id and process name instead.

​
Path parameters

Need help finding these IDs? See the Finding Identifiers and Parameters guide.
​
workspaceId
string
required
The ID of the workspace that owns the application.
​
appId
string
required
The ID of the application. Must exist in the specified workspace.
​
processName
string
required
The name of the process definition to start.

​
Request headers

​
Authorization
string
required
Bearer token from the configured identity provider. Format: Bearer <token>.
​
Content-Type
string
required
Must be application/json.

​
Request body

A JSON object with the initial process values. The exact shape depends on the process definition. 
{
  "customerEmail": "alice@example.com",
  "loanAmount": 25000
}

​
Response

Returns the new process instance, including its uuid (use this for subsequent calls) and state. 
{
  "processDefinitionName": "customer_onboarding",
  "uuid": "24cb4216-83a4-4782-84cb-d702b54b9b7d",
  "state": "STARTED",
  "applicationId": "dbe0ab87-539b-4015-962d-6e73226b9e58",
  "buildId": "7d5560be-3846-49fa-9c17-4059c54c7c5f",
  "instanceMetadata": {
    "processInstanceUuid": "24cb4216-83a4-4782-84cb-d702b54b9b7d"
  }
}

curl -X POST "{BASE_URL}/api/runtime/wks/{workspaceId}/app/{appId}/process-name/{processName}/start" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "customerEmail": "alice@example.com",
    "loanAmount": 25000
  }'
Last modified on June 2, 2026