Create Process Instance
Overview
Create a process instance using a process ID.
Endpoint
POST /api/processinstance/create
Use the service origin described in Getting started. The path above already includes /api.
Authentication
Send the access token obtained from Get Access Token in the Authorization header. Access is limited by the authenticated account’s permissions.
Request headers
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json
Request body
| Parameter | Type | Requirement | Description |
|---|---|---|---|
processId | integer | Required | Process ID returned by Get Process Definition. |
{
"processId": 19
}
Request example
The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it. Replace the AI Command Center origin with your deployment address.
curl --request POST \
--url 'https://command-center.example.com/api/processinstance/create' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"processId": 19
}'
Response
Successful status: 200 OK.
The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.
{
"processInstanceId": "917cf6d136954a52b62f8a259c898f64"
}
Response fields
The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.
| Field | Example type | Description |
|---|---|---|
processInstanceId | string | ID of the process execution. |
Errors
Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.