Endpoints
Trigger a Clipping Agent
POST endpoint to trigger an Agent run
POST
Endpoint
- Path Parameters
orgId
— Your organization’s ID.agentId
— The agent to trigger.nodeId
— The specific node within the agent to trigger.
This URL will be provided to you by navigating to Clipping Agents -> Agent -> Trigger via API
Authentication
All requests must include a valid Bearer token:
Found by pressing Trigger via API then Generate API Key
Request Body
url
(string, required) — The resource URL the workflow should process.notify
(boolean, optional) — Whether you’d like an email notification when finished. Defaults tofalse
.title
(string, optional) — Override title for the video. A title will be generated if it is not provided.
Sample Response
message
(string) — Confirmation text.status
(string) — Current status of the trigger (Processing
,Learning
,Completed
,Error
).triggerId
(string) — Unique identifier for this workflow run.