Alpha AnalystDocs
API Portal

User Document Search API

Platform-linked

Platform-linked: the key’s login needs an API plan and a website plan with Files; ApiKey only. How this works.

Search PDFs, Office files, and other uploads in your account or organization library. Requires sign-in.

curl -X GET "https://example.com/v2/user/documents?size=2"
{  "size": 2,  "results": [],  "count": 0}
GET
/v2/user/documents

Query Parameters

query?string

Keyword search over uploaded file text. Omit to list recent uploads. Excerpts are returned only when this is set.

Length1 <= length <= 2000
from_date?string

Inclusive start calendar date as YYYY-MM-DD or yyyyMMdd on upload day. See filed_at.

Match^[0-9]{8}$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$
to_date?string

Inclusive end calendar date as YYYY-MM-DD or yyyyMMdd on upload day. See filed_at.

Match^[0-9]{8}$|^[0-9]{4}-[0-9]{2}-[0-9]{2}$
file_types?array<string>

Uploaded file types (pdf, docx). Comma-separated on GET. Optional.

Items1 <= items <= 20
parent_folder_ids?array<string>

Folder ids to search. Comma-separated on GET. Optional. Pass main for files in the root folder (no parent).

Items1 <= items <= 50
sort_by?string

score or date. Default score. Ignored when query is omitted (browse is always by date).

Default"score"

Value in

  • "score"
  • "date"
sort_order?string

asc or desc. Default desc.

Default"desc"

Value in

  • "asc"
  • "desc"
size?integer

Page size. Default 15. Maximum 30.

Range1 <= value <= 30
Default15
chunks_size?integer

Excerpts per file when query is set. Default 5. Maximum 20.

Range1 <= value <= 20
Default5
next_id?string

Cursor from the previous page. Omit on the first page.

Length1 <= length <= 4000

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json