Search Agent Data

POST/api/v1/beta/agent-data/:search

Search agent data with filtering, sorting, and pagination.

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

Body ParametersExpand Collapse

deployment_name: string

The agent deployment's name to search within

collection: optional string

The logical agent data collection to search within

filter: optional map[object { eq, gt, gte, 3 more } ]

A filter object or expression that filters resources listed in the response.

eq: optional number or string or string

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

UnionMember2 = string

gt: optional number or string or string

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

UnionMember2 = string

gte: optional number or string or string

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

UnionMember2 = string

includes: optional array of number or string or string

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

UnionMember2 = string

lt: optional number or string or string

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

UnionMember2 = string

lte: optional number or string or string

Accepts one of the following:

UnionMember0 = number

UnionMember1 = string

UnionMember2 = string

include_total: optional boolean

Whether to include the total number of items in the response

offset: optional number

The offset to start from. If not provided, the first page is returned

maximum1000

minimum0

order_by: optional string

A comma-separated list of fields to order by, sorted in ascending order. Use 'field_name desc' to specify descending order.

page_size: optional number

The maximum number of items to return. The service may return fewer than this value. If unspecified, a default page size will be used. The maximum value is typically 1000; values above this will be coerced to the maximum.

page_token: optional string

A page token, received from a previous list call. Provide this to retrieve the subsequent page.

ReturnsExpand Collapse

items: array of AgentData { data, deployment_name, id, 4 more }

The list of items.

data: map[unknown]

deployment_name: string

id: optional string

collection: optional string

created_at: optional string

project_id: optional string

updated_at: optional string

next_page_token: optional string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size: optional number

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Search Agent Data

curl https://api.cloud.llamaindex.ai/api/v1/beta/agent-data/:search \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY" \
    -d '{
          "deployment_name": "deployment_name"
        }'

{
  "items": [
    {
      "data": {
        "foo": "bar"
      },
      "deployment_name": "deployment_name",
      "id": "id",
      "collection": "collection",
      "created_at": "2019-12-27T18:11:19.117Z",
      "project_id": "project_id",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}

Returns Examples

{
  "items": [
    {
      "data": {
        "foo": "bar"
      },
      "deployment_name": "deployment_name",
      "id": "id",
      "collection": "collection",
      "created_at": "2019-12-27T18:11:19.117Z",
      "project_id": "project_id",
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "next_page_token": "next_page_token",
  "total_size": 0
}