Start a run
Initiates a new run of the specified agent with the provided configuration parameters.
Sample request:
{
"inputParameters": {
"param1": "value1",
"param2": "value2"
},
"parallelism": 1,
"parallelMaxConcurrency": 2,
"parallelExport": true,
"proxyPoolId": 123,
"isExclusive": false,
"isWaitOnFailure": true,
"logLevel": "Info",
"logMode": "Normal"
}
Encrypted input parameters
Prefix a parameter name with ? to have its value encrypted at rest and hidden in
the Run log — for example "?apiKey" instead of "apiKey". The name you send decides
this. Sending a name without the ? prefix stores and logs the value in clear text,
even when the Agent defines that parameter as encrypted. Omitting a parameter
entirely leaves the Agent’s own definition in effect, encryption included.
If you send both "name" and "?name", the ?-prefixed entry is used and the plain
one is discarded. The request still succeeds.
Call GET /api/v1/agent/{agentId}/input-parameters to see which parameters an Agent
defines as encrypted.
Authorizations
API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"
OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"
Path Parameters
The ID of the agent to run
Body
The configuration parameters for the run
0 = Combined; 1 = Separated
Combined, Separated 0 = Fatal; 1 = Error; 2 = Warning; 3 = Info
Fatal, Error, Warning, Info 0 = Text; 1 = TextAndHtml
Text, TextAndHtml Response
Returns the ID of the newly created run
0 = Combined; 1 = Separated
Combined, Separated 0 = Invalid; 1 = Running; 2 = Exporting; 3 = Starting; 4 = Queuing; 5 = Stopping; 6 = Failure; 7 = Failed; 8 = Stopped; 9 = Completed; 10 = Success; 11 = Skipped; 12 = Waiting
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12