Skip to main content
GET
/
v2
/
agents
/
{agent_key}
/
tasks
List all tasks for an agent
curl --request GET \
  --url https://api.orq.ai/v2/agents/{agent_key}/tasks \
  --header 'Authorization: Bearer <token>'
{
  "tasks": [
    {
      "_id": "<string>",
      "agent_manifest_snapshot": {
        "_id": "<string>",
        "key": "<string>",
        "role": "<string>",
        "description": "<string>",
        "instructions": "<string>",
        "system_prompt": "<string>",
        "model": {
          "id": "<string>",
          "integration_id": "<string>",
          "fallback_models": [
            "<string>"
          ],
          "max_tokens": 123,
          "temperature": 1
        },
        "settings": {
          "max_execution_time": 300,
          "max_iterations": 15,
          "tool_approval_required": "respect_tool",
          "tools": []
        },
        "project_id": "<string>"
      },
      "created_by_id": "<string>",
      "updated_by_id": "<string>",
      "created": "<string>",
      "updated": "<string>",
      "name": "<string>",
      "workspace_id": "<string>",
      "memory": {
        "entity_id": "<string>"
      },
      "metadata": {},
      "state": {
        "waiting_for_approval": false,
        "inactive": true,
        "error": "<string>",
        "iteration": 1,
        "accumulated_execution_time": 0
      },
      "metrics": {
        "input_cost": 0,
        "output_cost": 0,
        "total_cost": 0,
        "prompt_tokens": 0,
        "completion_tokens": 0,
        "total_tokens": 0
      }
    }
  ],
  "overall_total": 123
}

Authorizations

Authorization
string
header
required

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

Path Parameters

agent_key
string
required

The unique key of the agent

Query Parameters

limit
number
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10

Required range: 1 <= x <= 200
starting_after
string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.

status
enum<string>

Comma-separated list of task statuses to filter by. Available values: inactive, approval_required, in_progress, errored

Available options:
inactive,
approval_required,
in_progress,
errored

Response

Agent tasks retrieved

tasks
object[]
required
overall_total
number
required