> ## 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.

# Start process by workspace, app, and process name

> Start a process using the workspace's active build — the simplest public REST entry point for triggering a FlowX process from your own backend or scheduled job.

> [!TIP]
>
> Looking for end-to-end guidance on calling FlowX from your own app? See [Consuming FlowX from external apps](https://docs.flowx.ai/6.x/docs/platform-deep-dive/integrations/consuming-flowx-from-external-apps.md).

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](https://docs.flowx.ai/6.x/docs/api/start-process/rest2.md) instead.

## Path parameters

> [!NOTE]
>
> **Need help finding these IDs?** See the [Finding Identifiers and Parameters](https://docs.flowx.ai/6.x/docs/platform-deep-dive/integrations/finding-identifiers-and-parameters.md) 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.

```json theme={"dark"}
{
  "customerEmail": "alice@example.com",
  "loanAmount": 25000
}
```

## Response

Returns the new process instance, including its `uuid` (use this for subsequent calls) and `state`.

```json theme={"dark"}
{
  "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"
  }
}
```

```bash theme={"dark"}
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
  }'
```


## Related topics

- [Start process and copy data from another instance](https://docs.flowx.ai/6.x/docs/api/start-process/start-with-copy-data.md)
- [Start process by build id and process name](https://docs.flowx.ai/6.x/docs/api/start-process/rest2.md)
- [Consuming FlowX from external apps](https://docs.flowx.ai/6.x/docs/platform-deep-dive/integrations/consuming-flowx-from-external-apps.md)
- [Initiating/starting processes](https://docs.flowx.ai/6.x/docs/flowx-designer/managing-a-project-flow/starting-a-process.md)
- [Tutorial: Build a credit card application](https://docs.flowx.ai/6.x/docs/getting-started/building-your-first-proc.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.