POST
/
v1
/
agents
/
run
/
default
/
{agent_type}
curl --request POST \
  --url https://api.roe-ai.com/v1/agents/run/default/{agent_type}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'task/prompt=<string>'
[
  {
    "key": "output",
    "description": "Output JSON data",
    "data_type": "application/json",
    "value": "{\"summary\": \"hello world!\"}"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agent_type
enum<string>
required

Type of default agent to run. For classification, agent inputs must include 'task' and 'target'. For extraction, agent inputs must include 'prompt' and 'target'.

Available options:
classification,
extraction

Body

​
task/prompt
string

Prompt for the agent to generate output; can be a file or a string

Minimum length: 1
​
target
file

Target data for the agent to process; can be a file or a string

Response

200
application/json
Agent outputs
​
key
string
required

The key of the output

​
data_type
string
required

The MIME data type of the output

​
value
string
required

The value of the output, serialized as a string

​
description
string | null

The description of the output

Run Agent AsyncRun Default Agent Async