Query Parameters
Body
Response
Required string length:
1 - 200Maximum length:
200API Documentation
Agents
- GETList Agents
- POSTCreate Agent
- GETRetrieve an Agent
- PUTUpdate an Agent's Settings
- DELDelete an Agent
- POSTDuplicate an Agent
- GETList Agent Versions
- POSTCreate Agent Version
- GETRetrieve an Agent Version
- GETRetrieve an Agent Version
- POSTRun Agent
- POSTRun Agent Async
- GETAgent Job Status
- GETAgent Job Result
- GETList Agent's Jobs
Create a new base agent.
Copy
curl --request POST \
--url https://api.roe-ai.com/v1/agents/ \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"engine_class_id": "<string>",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_name": "<string>",
"description": "<string>",
"input_definitions": "<any>",
"engine_config": "<any>"
}'Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creator": {
"id": 123,
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"disable_cache": true,
"cache_failed_jobs": true,
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"engine_class_id": "<string>",
"current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job_count": 123,
"most_recent_job": "2023-11-07T05:31:56Z",
"engine_name": "<string>",
"tags": "<string>"
}Agents
Create Agent
Create a new base agent.
POST
/
v1
/
agents
/
Create a new base agent.
Copy
curl --request POST \
--url https://api.roe-ai.com/v1/agents/ \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"engine_class_id": "<string>",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_name": "<string>",
"description": "<string>",
"input_definitions": "<any>",
"engine_config": "<any>"
}'Copy
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creator": {
"id": 123,
"email": "[email protected]",
"first_name": "<string>",
"last_name": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"disable_cache": true,
"cache_failed_jobs": true,
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"engine_class_id": "<string>",
"current_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"job_count": 123,
"most_recent_job": "2023-11-07T05:31:56Z",
"engine_name": "<string>",
"tags": "<string>"
}⌘I