Lookup Documents

Hybrid retrieval against indexed attachments owned by the caller's org.

The agent (and any client of the org's API key) calls this with the attachments attached to the session's template.

post/v1/documents/lookup

Request

Base URL
https://api.roxels.ai (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/roxels/apis/interviewer/docs/v1/documents/lookup/post.ts
A function with typed inputs. Its response is checked against the schema.

attachment_idsstring[]

Scope retrieval to these attachments. Empty list rejected — the caller must know which docs are in scope.

querystring required

section_hintstring nullable

top_kinteger

session_idstring nullable

turn_nointeger nullable

Successful Response

unknown required

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