Reference
Run Agent
POST
Initiate the execution of a specific Agent by its name. You can specify input variables, metadata, and choose which version of the Agent to run.
Please note that this feature was previously called “Workflows” and is now called “Agents”. Some references to “Workflows” remain in our SDK and will be updated before the feature exits beta.
HTTP Request
POST /workflows/{workflow_name}/run
Path Parameters
- workflow_name (string, required): The name of the Agent you wish to execute.
Request Body
The request body expects a JSON object with the following structure:
Schema
Headers
Your API key for authentication.
Path Parameters
The name of the workflow to execute.
Body
application/json
Parameters to run a workflow.
Response
201
application/json
Workflow execution created successfully
Response after initiating a workflow execution.