Skip to main content
POST
Refresh a reference document from Google Drive

Authorizations

X-API-Key
string
header
required

Path Parameters

document_id
string<uuid>
required

Response

Successful Response

One reference document: what it is, how far it got, and what prompts read.

content_type
string
required
created_at
string<date-time>
required
drive_file_id
string | null
required

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

error
string | null
required

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

filename
string
required
id
string<uuid>
required
included_in_context
boolean
required

Whether this document's summary joins the business context.

size_bytes
integer
required
source
enum<string>
required

Whether the file was uploaded or linked from Google Drive.

Available options:
upload,
google_drive
status
enum<string>
required

Poll the list while any document is still processing.

Available options:
pending,
processing,
ready,
failed
summary
string | null
required

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

summary_edited
boolean
required

True once somebody saved over the written summary by hand.

summary_generated_at
string<date-time> | null
required
title
string
required
updated_at
string<date-time>
required
in_prompt_budget
boolean
default:true

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