---
title: "Search an agent's documents"
method: POST
path: "/voice/agents/{agent_id}/documents/search"
tags: ["Voice"]
---

# Search an agent's documents

`POST /voice/agents/{agent_id}/documents/search`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/voice/agents/{agent_id}/documents/search`
- Auth: HTTP bearer

SPENDS NOTHING billable. The chunks the agent would retrieve for `query`.
Voice binds form fields, so the body is re-encoded as form data.

## Path parameters

- `agent_id` string, required: Voice agent id.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- AgentDocumentSearch: voice binds `query` and `top_k` as FORM fields beside `org_id` and `agent_id`; the router re-encodes this body as form data.
  - `query` string, required
  - `top_k` integer

## Response `200`

Successful Response

- ApiResponseVoicePayload
  - `data` VoicePayload, required: One voice object - a collection, an agent, a route, a chat. Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)