POST
/
rtm
/
api
/
runtime
/
app
/
{appId}
/
build
/
{buildId}
/
process-name
/
{processDefinitionName}
/
start
curl -X POST "https://admin.devmain.flowxai.dev/rtm/api/runtime/app/{appId}/build/{buildId}/process-name/{processDefinitionName}/start" \
  -H "Authorization: Bearer <token>" \                    # Required
  -H "Content-Type: application/json" \                   # Required
  -H "flowx-platform: web" \                              # Required
  -H "Accept: application/json, text/plain, */*" \        # Optional
  -H "Accept-Encoding: gzip, deflate, br, zstd" \         # Optional
  -H "Accept-Language: en-GB,en-US;q=0.9,en;q=0.8" \      # Optional
  -d '{
    "key": "value"
  }'

{
  "processDefinitionFlowxUuid": "<string>",
  "buildId": "<string>",
  "buildStatusAtStart": "<string>",
  "applicationId": "<string>",
  "parentApplicationId": {},
  "rootApplicationId": {},
  "processDefinitionName": "<string>",
  "tokens": [
    {}
  ],
  "state": "<string>",
  "uuid": "<string>",
  "instanceMetadata": {},
  "Access-Control-Allow-Credentials": true,
  "Access-Control-Allow-Headers": "<string>",
  "Access-Control-Allow-Methods": "<string>",
  "Access-Control-Allow-Origin": "<string>",
  "Content-Encoding": "<string>",
  "Content-Type": "<string>",
  "Strict-Transport-Security": "<string>",
  "Vary": "<string>",
  "X-Content-Type-Options": "<string>",
  "X-XSS-Protection": "<string>"
}

​
Base URL

  • Always prepend the endpoint with the correct Base URL.
  • For different environments (like staging or production), switch the base URL accordingly.

​
Path Parameters

​
appId
string
required

The ID of the application.

​
buildId
string
required

The build ID for the runtime environment.

​
processDefinitionName
string
required

The name of the process definition to start.

​
Request headers

​
Authorization
string
required

Bearer token required for authentication. Format: Bearer <token>.

​
Content-Type
string
required

Indicates the media type of the request body. Must be set to application/json.

​
Flowx-Platform
string
required

Identifies the client platform (e.g., web).

​
Accept
string

Specifies the media types that are acceptable for the response. Example: application/json, text/plain, */*.

​
Accept-Encoding
string

Indicates supported content encoding algorithms for the response. Example: gzip, deflate, br, zstd.

​
Accept-Language
string

Specifies language preferences for the response. Example: en-GB,en-US;q=0.9,en;q=0.8.

​
User-Agent
string

Identifies the client software making the request (e.g., browser or tool).

​
Referer
string

The address of the previous web page from which the request was made.

​
Request Body

This endpoint requires a JSON request body. The exact payload structure should conform to the process definition schema associated with {processDefinitionName}.

​
key1
string
required

Description of what key1 represents

​
key2
string
required

Description of what key2 represents

​
Example Request Body

{
  "key1": "value1",
  "key2": "value2"
}

​
Response

​
processDefinitionFlowxUuid
string

The unique identifier of the process definition within FlowX.

​
buildId
string

The ID of the build associated with the process.

​
buildStatusAtStart
string

The status of the build at the time the process was started (e.g., “COMMITTED”).

​
applicationId
string

The ID of the application where the process was initiated.

​
parentApplicationId
string or null

The ID of the parent application if applicable, otherwise null.

​
rootApplicationId
string or null

The ID of the root application if applicable, otherwise null.

​
processDefinitionName
string

The name of the process definition that was started.

​
tokens
array

A list of tokens representing active workflow states within the process.

​
state
string

The current state of the process instance (e.g., “STARTED”).

​
uuid
string

The unique identifier for the process instance.

​
instanceMetadata
object

Metadata related to the process instance, including:

  • processInstanceId: The numeric ID of the process instance.
  • processInstanceUuid: The UUID of the process instance.

​
Response Headers

​
Access-Control-Allow-Credentials
boolean

Indicates whether the response can be exposed when credentials are present. Value is true.

​
Access-Control-Allow-Headers
string

Lists the allowed headers in the actual request. Example: DNT, Keep-Alive, User-Agent, X-Requested-With, If-Modified-Since, Cache-Control, Content-Type, Range, Authorization, flowx-platform.

​
Access-Control-Allow-Methods
string

Specifies the allowed HTTP methods. Example: GET, PUT, POST, DELETE, PATCH.

​
Access-Control-Allow-Origin
string

Indicates the allowed origin for cross-origin requests. Example: https://demo-angular.devmain.flowxai.dev.

​
Content-Encoding
string

Specifies the encoding used to compress the response. Example: gzip.

​
Content-Type
string

Indicates the media type of the response content. Example: application/json.

​
Strict-Transport-Security
string

Enforces secure (HTTPS) connections to the server. Example: max-age=31536000 ; includeSubDomains.

​
Vary
string

Specifies that the response may vary based on the Accept-Encoding request header. Example: Accept-Encoding.

​
X-Content-Type-Options
string

Prevents the browser from MIME-sniffing a response away from the declared Content-Type. Example: nosniff.

​
X-XSS-Protection
string

Controls the cross-site scripting (XSS) filter. Example: 0 (disabled).

curl -X POST "https://admin.devmain.flowxai.dev/rtm/api/runtime/app/{appId}/build/{buildId}/process-name/{processDefinitionName}/start" \
  -H "Authorization: Bearer <token>" \                    # Required
  -H "Content-Type: application/json" \                   # Required
  -H "flowx-platform: web" \                              # Required
  -H "Accept: application/json, text/plain, */*" \        # Optional
  -H "Accept-Encoding: gzip, deflate, br, zstd" \         # Optional
  -H "Accept-Language: en-GB,en-US;q=0.9,en;q=0.8" \      # Optional
  -d '{
    "key": "value"
  }'