Start Process
This endpoint initiates a process in the application runtime environment using the specified buildId and processDefinitionName.
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
The ID of the application.
The build ID for the runtime environment.
The name of the process definition to start.
Request headers
Bearer token required for authentication. Format: Bearer <token>.
Indicates the media type of the request body. Must be set to application/json.
Identifies the client platform (e.g., web).
Specifies the media types that are acceptable for the response. Example: application/json, text/plain, */*.
Indicates supported content encoding algorithms for the response. Example: gzip, deflate, br, zstd.
Specifies language preferences for the response. Example: en-GB,en-US;q=0.9,en;q=0.8.
Identifies the client software making the request (e.g., browser or tool).
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}.
Description of what key1 represents
Description of what key2 represents
Example Request Body
Response
The unique identifier of the process definition within FlowX.
The ID of the build associated with the process.
The status of the build at the time the process was started (e.g., “COMMITTED”).
The ID of the application where the process was initiated.
The ID of the parent application if applicable, otherwise null.
The ID of the root application if applicable, otherwise null.
The name of the process definition that was started.
A list of tokens representing active workflow states within the process.
The current state of the process instance (e.g., “STARTED”).
The unique identifier for the process instance.
Metadata related to the process instance, including:
processInstanceId: The numeric ID of the process instance.processInstanceUuid: The UUID of the process instance.
Response Headers
Indicates whether the response can be exposed when credentials are present. Value is true.
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.
Specifies the allowed HTTP methods. Example: GET, PUT, POST, DELETE, PATCH.
Indicates the allowed origin for cross-origin requests. Example: https://demo-angular.devmain.flowxai.dev.
Specifies the encoding used to compress the response. Example: gzip.
Indicates the media type of the response content. Example: application/json.
Enforces secure (HTTPS) connections to the server. Example: max-age=31536000 ; includeSubDomains.
Specifies that the response may vary based on the Accept-Encoding request header. Example: Accept-Encoding.
Prevents the browser from MIME-sniffing a response away from the declared Content-Type. Example: nosniff.
Controls the cross-site scripting (XSS) filter. Example: 0 (disabled).
Was this page helpful?