Get Agent Data
Overview
Retrieve Agent Data for a process instance. Agent Data is shared across all workflows within that execution. A workflow instance ID is not required.
Endpoint
GET /api/processinstance/agentdata
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
Query parameters
| Parameter | Type | Requirement | Description |
|---|---|---|---|
processInstanceId | string | Required | Execution ID returned by Create Process Instance. |
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 GET \
--url 'https://command-center.example.com/api/processinstance/agentdata?processInstanceId=917cf6d136954a52b62f8a259c898f64' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN'
Response
Successful status: 200 OK.
The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.
{
"CustomerName": "Acme Corp",
"OrderIds": [
"ORD-1001"
]
}
Agent Data is shared across workflows within one process execution. A workflow instance ID is not required. Field names and value types must match the agent’s definitions.
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 |
|---|---|---|
CustomerName | string | Illustrative text field defined in Agent Data. |
OrderIds | array | Illustrative array of text fields defined in Agent Data. |
The example assumes a text field named CustomerName and a text field array named OrderIds in the agent’s definitions.
Errors
Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.