Update Document
Shallow-merge data into the stored document (a JSON null removes a
field) and write the result as a new version.
Dark launch: requires the hosted_apis_access entitlement (402 hosted_apis_not_in_plan otherwise).
Authentication
AuthorizationBearer
Enter your API key with the Bearer prefix, e.g. ‘Bearer sk_…’.
Path parameters
store_id
Store id (prefixed external id, store_...).
collection
Collection name (lowercase letters, digits, _, -).
document_id
Document id.
Headers
Speechify-Version
Request
This endpoint expects an object.
data
The document body (a JSON object, at most 256 KiB). On updateDocument, the fields to merge; a null removes a field.
id
On createDocument, the id to write at (letters, digits, _ . - : ~ @ +, at most 200);
minted when absent. Ignored on putDocument / updateDocument, where the URL names it.
Response headers
Speechify-Request-Id
Unique identifier for this request, present on every response (2xx and
non-2xx alike). If the caller sends a `Speechify-Request-Id` request
header the server echoes it back (sanitized and length-capped) so one
logical request can be traced end-to-end; otherwise the server generates
a fresh value. Log it on every response and quote it in support requests
- it is the stable handle that ties your observation to Speechify's
server-side logs, and it matches the `request_id` field in the error
envelope.
The legacy alias `X-Request-ID` carries the same value and is still
accepted on requests, until 2027-07-24. Prefer the un-prefixed name
(RFC 6648).
Response
OK
id
collection
version
Incremented on every write to this id.
size_bytes
created_at
updated_at
source
The durable run (and its journal step) that wrote this version. Absent for a direct API write.
data
The document body. Absent when the caller asked for index rows only.
Errors
400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
503
Service Unavailable Error