Edit enrichment suggestion values
Edits specific suggestion values under an agent execution before they are accepted. Suggestions that do not belong to this agent execution are reported in skippedIds.
patch
https://{your-bynder-domain}/api/1/agent/enrichment/executions/{id}/edit
Path Parameters
idstring(uuid)required
Id of the agent execution
Body
application/json
Body
application/json
EditSuggestionsRequest
Edit request. The agent execution comes from the {id} path segment.
inlineChangesarray[object]required
>= 1 items
Show Child Parameters
Response
application/json
Response
application/json
Edit command published; applied asynchronously
CommandAcceptedResponse
correlationIdstring(uuid)
skippedIdsarray[string](uuid)
Requested ids not owned by this account and so not processed. The rest of the request still went through.
patch/api/1/agent/enrichment/executions/{id}/edit
Authentication
Path Parameters
Body
{
"inlineChanges": [
{
"suggestionId": "suggestionId"
}
]
}
application/json
Undo inline edits of enrichment suggestions
Undoes earlier inline edits, restoring the given suggestions to their original values. Same resource as PATCH: PATCH applies an edit, DELETE removes it. Suggestions that do not belong to this agent execution are reported in skippedIds.
delete
https://{your-bynder-domain}/api/1/agent/enrichment/executions/{id}/edit
Path Parameters
idstring(uuid)required
Id of the agent execution
Body
application/json
Body
application/json
UndoEditSuggestionsRequest
Undo-edit request. The agent execution comes from the {id} path segment.
suggestionIdsarray[string](uuid)required
>= 1 items
Response
application/json
Response
application/json
Undo-edit command published; applied asynchronously
CommandAcceptedResponse
correlationIdstring(uuid)
skippedIdsarray[string](uuid)
Requested ids not owned by this account and so not processed. The rest of the request still went through.
delete/api/1/agent/enrichment/executions/{id}/edit
Authentication
Path Parameters
Body
{
"suggestionIds": []
}
application/json
ErrorResponse
objectcodestring
messagestring
Example
Agent
objectAn agent.
idstring(uuid)read-only
namestring
descriptionstring
promptobject
An agent prompt.
Show Child Parameters
createdAtstring(date-time)
modifiedAtstring(date-time)
accountIdstring(uuid)
statusstring
Allowed values:ACTIVEINACTIVEDRAFT
autoApplyboolean
autoApplyUserIdstring(uuid)
agentsarray[string]
The capabilities of the agent.
Allowed values:ENRICHMENT_AGENTTRANSFORMATION_AGENTBRAND_COMPLIANCE_AGENTGOVERNANCE_AGENTPATH_GENERATOR_AGENT
agentPropertiesobject
* Additional properties are allowed.
createdBystring(uuid)
Example
AgentCreateRequest
objectThe agent to create. capabilities defines what the agent can do and cannot be changed afterwards.
autoApplyboolean
namestringrequired
<= 50 characters
descriptionstringrequired
<= 130 characters
capabilitiesarray[string]required
Allowed values:ENRICHMENT_AGENTTRANSFORMATION_AGENTBRAND_COMPLIANCE_AGENTGOVERNANCE_AGENTPATH_GENERATOR_AGENT
>= 1 items
agentPropertiesobjectrequired
* Additional properties are allowed.
promptobject
The prompt to set on an agent when you create or edit it. Unlike the read-only Prompt in responses, id and version are optional here.
Show Child Parameters
statusstring
Allowed values:ACTIVEINACTIVEDRAFT
Example