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
- GETGet all browser events for an execution
Credentials
Notifications
Workflow
Get a workflow
GET
/
workflow
/
{workflow_id}
Copy
{
"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": {},
"start_url": "https://www.google.com",
"fields": {
"model": "gpt-4o",
"version": "2024-02-01"
}
}
Path Parameters
Response
200
application/json
Workflow
The response is of type object
.
Copy
{
"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": {},
"start_url": "https://www.google.com",
"fields": {
"model": "gpt-4o",
"version": "2024-02-01"
}
}
Assistant
Responses are generated using AI and may contain mistakes.