Skip to main content
POST
/
v1
/
agents
/
run
/
{agent_id}
curl --request POST \
  --url "https://api.roe-ai.com/v1/agents/run/YOUR_AGENT_ID/" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "inputs": {
      "key": "value"
    }
  }'

[
  {
    "key": "<string>",
    "data_type": "<string>",
    "value": "<string>",
    "description": "<string>",
    "cost": 123
  }
]
curl --request POST \
  --url "https://api.roe-ai.com/v1/agents/run/YOUR_AGENT_ID/" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "inputs": {
      "key": "value"
    }
  }'

Path Parameters

​
agent_id
string<uuid>
required

Body

Serializer for agent execution requests with dynamic input fields.

​
metadata
any

Optional metadata as JSON object or JSON string

​
agent_input_key_example
string

Agent input keys are dynamic based on agent configuration. Can be text or file.

Minimum string length: 1

Response

Agent job result

​
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

The description of the output

​
cost
number<double>

The cost of the agent job execution