Batch Write Documents
Apply up to 50 writes (set, update, delete) in order. Not atomic
across writes: it stops at the first failure, whose index the error
names, and reports every write it applied.
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, _, -).
Headers
Speechify-Version
Idempotency-Key
A client-generated key (an opaque string, max 255 chars) that makes a
side-effect POST safe to retry: the server runs the operation exactly
once and replays the first response (its status and body) for 24 hours.
Reusing a key with a different request body, or while the first request
is still in flight, returns `409 idempotency_conflict`. A replayed
response carries the `Idempotent-Replayed: true` header.
Request
This endpoint expects an object.
writes
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
results
Errors
400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
409
Conflict Error
503
Service Unavailable Error