ai-context

Get a reference document

Read one reference document's current state and summary.

get/ai-context/documents/{document_id}/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/ai-context/documents/{document_id}/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

document_idstring uuid required

Response

Successful Response

content_typestring required
created_atstring date-time required
drive_file_idstring nullable required
drive_web_view_linkstring nullable required

Where to open the original in Google Drive, for linked documents.

errorstring nullable required

Why the document could not be read, written for the reader.

filenamestring required
idstring uuid required
in_prompt_budgetboolean

Whether this document's summary actually fits the prompt budget alongside the documents before it. Computed on the list; a single read reports true.

included_in_contextboolean required

Whether this document's summary joins the business context.

size_bytesinteger required
source'upload' | 'google_drive' required

Where a reference document came from.

status'pending' | 'processing' | 'ready' | 'failed' required

How far a reference document has got through extraction and summarizing.

Unlike a generation job, PENDING IS observed here: the row commits first and its workflow starts after that commit, so a reader can catch the gap. The two terminal states are absorbing.

summarystring nullable required

The markdown summary that stands in for this document in AI prompts.

summary_editedboolean required

True once somebody saved over the written summary by hand.

summary_generated_atstring date-time nullable required
titlestring required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 2 revisions of this API.