Run agent
Runs one or more agents on assets. Send one item per agent, each with the asset list to process. The request is accepted as a whole: agents that could not be started are listed in error in the response, with the reason, and the ones that did start are listed in success.
post
https://{your-bynder-domain}/api/1/agent/executions
Body
application/json
Body
application/json
ExecutionRequest
A request to run one agent.
>= 1 items<= 100 items
agentIdstring(uuid)required
assetIdsarray[string](uuid)required
>= 1 items<= 10000 items
agentExecutionNamestring
<= 256 characters
workspaceBatchIdstring | null(uuid)
Response
application/json
Response
application/json
Execution(s) accepted for processing. The response lists the executions that were created, the requests that failed, and a summary.
ExecutionResult
The outcome of a run request.
successarray[object]
The executions that were created.
Show Child Parameters
errorarray[object]
The run requests that failed.
Show Child Parameters
executionSummaryobject
Counts of run requests by outcome.
post/api/1/agent/executions
Authentication
Body
[
{
"agentId": "agentId",
"assetIds": []
}
]
application/json
Get agent execution
Returns a single agent execution by id.
get
https://{your-bynder-domain}/api/1/agent/executions/{id}
Path Parameters
idstring(uuid)required
Id of the agent execution
Response
application/json
Response
application/json
Agent execution
Execution
An agent execution.
idstring(uuid)
statusstring
Allowed values:RUNNINGACTION_REQUIREDCOMPLETED
agentIdstring | null(uuid)
agentNamestring
assetCountinteger | null
createdAtstring(date-time)
modifiedAtstring(date-time)
assetStatusCountsobject
Number of asset executions per status.
ranByobject | null
Who started the execution: a user or an automation rule.
Show Child Parameters
accountIdstring(uuid)
workspaceBatchIdstring | null(uuid)
agentCapabilitystring | null
Allowed values:ENRICHMENT_AGENTTRANSFORMATION_AGENTBRAND_COMPLIANCE_AGENTGOVERNANCE_AGENTPATH_GENERATOR_AGENT
get/api/1/agent/executions/{id}
Authentication
Path Parameters
application/json
Cancel agent execution
Cancels an agent execution that have not finished yet.
post
https://{your-bynder-domain}/api/1/agent/executions/{id}/cancel
Path Parameters
idstring(uuid)required
Id of the agent execution
Response
Response
Cancellation processed (or nothing to cancel)
post/api/1/agent/executions/{id}/cancel
Authentication
Path Parameters
List asset executions for an agent execution
Returns the per-asset executions belonging to an agent execution, paginated.
get
https://{your-bynder-domain}/api/1/agent/executions/{id}/asset-executions
Query Parameters
statusesarray[string]
Only return asset executions with these statuses.
Allowed values:SCHEDULEDRUNNINGFAILEDCOMPLETEDACCEPTEDAUTO_APPLIEDDISCARDEDCANCELEDREVERTED
startstring(uuid)
Cursor from the previous page’s nextPage. Omit for the first page.
limitinteger
Default:20
>= 1<= 100
sortstring
Default:-modifiedAt
Path Parameters
idstring(uuid)required
Id of the agent execution
Response
application/json
Response
application/json
Paginated list of asset executions
PaginatedAssetExecutions
A page of asset executions. metadata.nextPage is a query string to add to the same request URL, or null on the last page.
itemsarray[object]
The execution of an agent on a single asset, including capability-specific results (for example, suggestions for the enrichment capability).
Show Child Parameters
metadataobject
Show Child Parameters
get/api/1/agent/executions/{id}/asset-executions
Authentication
Path Parameters
Query Parameters
application/json
Get a single asset execution
Returns a single asset execution belonging to an agent execution.
get
https://{your-bynder-domain}/api/1/agent/executions/{id}/asset-executions/{assetExecutionId}
Path Parameters
idstring(uuid)required
Id of the agent execution
assetExecutionIdstring(uuid)required
Id of the asset execution, scoped to its parent agent execution
Response
application/json
Response
application/json
Asset execution
AssetExecution
The execution of an agent on a single asset, including capability-specific results (for example, suggestions for the enrichment capability).
idstring(uuid)
agentExecutionIdstring(uuid)
assetIdstring(uuid)
statusstring
The status of the asset execution.
Allowed values:SCHEDULEDRUNNINGFAILEDCOMPLETEDACCEPTEDAUTO_APPLIEDDISCARDEDCANCELEDREVERTED
createdAtstring(date-time)
resultsobject
* Additional properties are allowed.
assetNamestring | null
draftboolean
removedboolean
errorCodestring | null
agentTypestring | null
Allowed values:ENRICHMENT_AGENTTRANSFORMATION_AGENTBRAND_COMPLIANCE_AGENTGOVERNANCE_AGENTPATH_GENERATOR_AGENT
thumbnailobject | null
Show Child Parameters
get/api/1/agent/executions/{id}/asset-executions/{assetExecutionId}
Authentication
Path Parameters
application/json