Agents

List relevant pages for an agent

Return document pages that have been classified as relevant for this agent. Pages classified as irrelevant or not yet classified are omitted.

get/projects/{project_id}/agents/{agent_id}/relevant-pages/

Request

  • Base URL
    https://api.parsewise.ai/api/v1
  • Auth
    API key in header X-API-Key

Path parameters

agent_idstring uuid required
project_idstring uuid required

Query parameters

limitinteger

Maximum pages to return. Defaults to 100 and is capped at 1000.

offsetinteger

Zero-indexed offset into the ordered relevant pages. Defaults to 0. Increase by limit until a response contains fewer items than requested.

Response

document_idstring uuid required

Stable identifier of the document.

document_namestring required

Original filename of the document.

page_numberinteger required

1-indexed page number within the document.

Changes

No recorded changes to this operation across all 1 revision of this API.