Workflow
Get all workflows and their executions
Agent
Optimiser
Workflow
- POSTCreate a new workflow for an agent
- GETGet a workflow
- POSTExecute a saved workflow for an agent
- DELDelete a workflow
- GETGet credentials for a workflow (and all prior versions of the workflow)
- DELDelete credentials for a workflow
- PATCHAdd a credential for a workflow
- GETGet all workflows and their executions
- GETGet all versions of a workflow
Execution
- GETGet all executions for a workflow
- GETGet an execution
- DELDelete an execution
- POSTUpdate the status of an execution
- GETGet the browser session for an execution
- GETGet the progress of an execution
- GETGet files for an execution
- GETGet all user messages for an execution
- POSTCreate a user message for an execution
Credentials
Notifications
Workflow
Get all workflows and their executions
GET
/
agent
/
{agent_name}
/
workflows
[
{
"workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"result_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"type": "object",
"required": [
"submission_id",
"status"
],
"properties": {
"submission_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"success",
"failure"
]
}
}
},
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"prompts": [
"Your name is {{.name}}, you speak {{.language}}",
"Your task is {{.task}}"
],
"prompt_variables": [
"name",
"language",
"task"
],
"workflow_options": {
"model": "gpt-4o",
"version": "2024-02-01"
},
"start_url": "https://www.google.com",
"fields": {
"model": "gpt-4o",
"version": "2024-02-01"
}
},
"executions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dynamic_data": {
"name": "Alice",
"model": "gpt-4o"
},
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": {
"execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "starting",
"reason": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"result": {},
"created_at": "2023-11-07T05:31:56Z",
"error": "<string>"
}
]
}
]Path Parameters
Response
200 - application/json
List of workflow executions
Workflow identifier.
The ID of the user who created the workflow.
Example:
"123e4567-e89b-12d3-a456-426614174000"
A JSON Schema that defines the expected structure and validation rules for workflow results.
Example:
{
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"type": "object",
"required": ["submission_id", "status"],
"properties": {
"submission_id": { "type": "string" },
"status": {
"type": "string",
"enum": ["success", "failure"]
}
}
}
Identifier of the associated agent.
Workflow name.
The prompts for the workflow. They can have variables in them. They will be merged with the dynamic data passed when the workflow is executed.
Example:
[
"Your name is {{.name}}, you speak {{.language}}",
"Your task is {{.task}}"
]
The URL to start the workflow.
Example:
"https://www.google.com"
The date and time the workflow was created.
The variables in the prompts.
Example:
["name", "language", "task"]
Additional options for the workflow. See documentation for more details.
Example:
{
"model": "gpt-4o",
"version": "2024-02-01"
}
JSON object containing static workflow configuration (e.g. a prompt_template).
Example:
{
"model": "gpt-4o",
"version": "2024-02-01"
}
Execution identifier.
Run ID.
Workflow ID.
The result of the execution.
The date and time the execution was created.
Dynamic data to be merged into the saved workflow configuration.
Example:
{ "name": "Alice", "model": "gpt-4o" }
Execution ID.
Status of the execution.
Available options:
starting, running, paused, completed, cancelled, failed The date and time the execution status was created.
Reason for the status.
The error that occurred during the execution.
[
{
"workflow": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_id": "123e4567-e89b-12d3-a456-426614174000",
"result_schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"type": "object",
"required": [
"submission_id",
"status"
],
"properties": {
"submission_id": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"success",
"failure"
]
}
}
},
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"prompts": [
"Your name is {{.name}}, you speak {{.language}}",
"Your task is {{.task}}"
],
"prompt_variables": [
"name",
"language",
"task"
],
"workflow_options": {
"model": "gpt-4o",
"version": "2024-02-01"
},
"start_url": "https://www.google.com",
"fields": {
"model": "gpt-4o",
"version": "2024-02-01"
}
},
"executions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dynamic_data": {
"name": "Alice",
"model": "gpt-4o"
},
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": {
"execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "starting",
"reason": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"result": {},
"created_at": "2023-11-07T05:31:56Z",
"error": "<string>"
}
]
}
]