Skip to main content
GET
/
v1
/
agents
/
{agent_id}
/
jobs
curl --request GET \
  --url "https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/jobs/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY"

{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_version_name": "<string>",
      "status_events": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "status_code": 123,
          "error_message": "<string>",
          "error_details": {},
          "count": 123
        }
      ],
      "status_code": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "last_updated_at": "2023-11-07T05:31:56Z",
      "duration_ms": 123,
      "ui_fields": "<unknown>",
      "evaluation": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "reference": null,
        "human_score": 123,
        "grader_score": 123,
        "feedback": "<string>"
      },
      "feedback_review": {
        "reviewed_by": "<string>",
        "corrected_verdict": "<string>",
        "review_comment": "<string>",
        "reviewed_at": "2023-11-07T05:31:56Z"
      },
      "job_inputs": [
        {
          "key": "<string>",
          "description": "<string>",
          "data_type": "<string>",
          "value": "<string>",
          "file_name": "<string>"
        }
      ],
      "metadata": {}
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Documentation Index

Fetch the complete documentation index at: https://docs.roe-ai.com/llms.txt

Use this file to discover all available pages before exploring further.

curl --request GET \
  --url "https://api.roe-ai.com/v1/agents/YOUR_AGENT_ID/jobs/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY"

Path Parameters

​
agent_id
string<uuid>
required

Query Parameters

​
created_from
string<date-time>
​
created_to
string<date-time>
​
exclude_metadata
string
​
job_id
string
​
job_inputs
string
​
metadata
string
​
ordering
enum<string>[]

Ordering

  • id - Job ID
  • -id - Job ID (descending)
  • agent_version_name - Version
  • -agent_version_name - Version (descending)
  • status_code - Status
  • -status_code - Status (descending)
  • created_at - Created At
  • -created_at - Created At (descending)
  • last_updated_at - Last Updated At
  • -last_updated_at - Last Updated At (descending)
  • cost - Cost
  • -cost - Cost (descending)
  • duration - Time Elapsed
  • -duration - Time Elapsed (descending)
  • grader_score - Score
  • -grader_score - Score (descending)
Available options:
-agent_version_name,
-cost,
-created_at,
-duration,
-grader_score,
-id,
-last_updated_at,
-status_code,
agent_version_name,
cost,
created_at,
duration,
grader_score,
id,
last_updated_at,
status_code
​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
search
string
​
semantic_string
string

Semantic search string for finding similar jobs using embeddings

​
status_code
string
​
version_name
string
​
organization_id
string<uuid>

Organization ID. This is required for access control. It can be provided via query or request body depending on the endpoint.

Response

Successfully retrieved paginated list of agent jobs.

​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"