Agents
Run Default Agent
POST
/
v1
/
agents
/
run
/
default
/
{agent_type}
/
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
agent_type
enum<string>
requiredType 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
target
file
Target data for the agent to process; can be a file or a string
Response
200 - application/json
key
string
requiredThe key of the output
description
string | null
The description of the output
data_type
string
requiredThe MIME data type of the output
value
string
requiredThe value of the output, serialized as a string