GET
/
v1
/
agents
/
{agent_id}
/
jobs
/
List agent jobs or create a new agent job.
curl --request GET \
  --url https://api.roe-ai.com/v1/agents/{agent_id}/jobs/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "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",
      "job_inputs": [
        {
          "key": "<string>",
          "description": "<string>",
          "data_type": "<string>",
          "value": "<string>",
          "file_name": "<string>"
        }
      ],
      "metadata": {},
      "evaluation": {
        "reference": "<any>",
        "human_score": 123,
        "grader_score": 123,
        "feedback": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

agent_id
string<uuid>
required

Query Parameters

created_from
string<date-time>
created_to
string<date-time>
job_id
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)
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

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"