AI Command Center API

Overview

Manage users, processes, tasks, Buddies, jobs, and runtime data in your AI Command Center deployment.

Service origin

https://command-center.example.com

Replace the example origin with your deployment’s HTTPS origin. Ask your administrator for the address and tenant details. Endpoint paths include /api; append them directly to the origin, without adding another /api.

Get started

1. Obtain an account with access to the resources you need. Ask your administrator for the appropriate roles and resource permissions.
2. Call Get Access Token with your credentials.
3. Copy the returned accesstoken value into the Bearer header below.
4. Run the request with your own origin and process name. The command uses cURL in a POSIX shell.

curl --request GET \
  --url 'https://command-center.example.com/api/processdefinition/byName?name=Expense-Report-Approval' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer ACCESS_TOKEN'

A successful request returns 200 OK and the process definition, including its processId. See Get Process Definition for an example response.

Authentication

Protected operations use Bearer access tokens. Login uses account credentials. Token lifetime and renewal behavior must be confirmed for your deployment.

Endpoints

Operation	Method and path	Purpose
Complete Task	PUT /api/task/complete	Complete a task using its task ID.
Create Environment Variable	POST /api/evar/create	Create an environment variable in AI Command Center.
Create Process Instance	POST /api/processinstance/create	Create a process instance using a process ID.
Create User	POST /api/user/create	Create a user and assign roles in AI Command Center.
Get Activity Instance Info	GET /api/processinstance/activityInstanceById	Retrieve an activity instance using its process instance ID and activity instance ID.
Get Agent Data	GET /api/processinstance/agentdata	Retrieve Agent Data for a process instance.
Get Access Token	POST /api/auth/login	Obtain an access token by signing in with your account credentials.
Get Job Status	GET /api/job/status	Retrieve the execution status of a job.
Get Pending Tasks	GET /api/task/pending	Retrieve pending tasks for a user and process.
Get Process Definition	GET /api/processdefinition/byName	Retrieve a process definition by its name.
Get SmartBuddy by Name	GET /api/smartbuddy/byName	Retrieve a SmartBuddy by its name.
Get Tasks by Process Instance	GET /api/processinstance/tasks	Retrieve tasks for a process instance, including their task IDs.
Start Job	POST /api/job/start	Start a job using a process and a Buddy.
Update Agent Data	POST /api/processinstance/submitAgentData	Update Agent Data for a process instance.
Update Workflow Data	POST /api/processinstance/submitModelData	Update Workflow Data for a workflow instance.
Update SmartBuddy	PUT /api/smartbuddy/update	Update a SmartBuddy and its associated reference entries.

Next steps

For task automation, retrieve a process definition, create an instance using its processId, list that instance’s tasks, and complete the intended task. For Buddy automation, retrieve a process and Buddy, start a job, then inspect its status. Use IDs returned by each operation instead of copying example IDs.

See Usage and troubleshooting for response conventions, retry considerations, and current reference limitations.