rest api documents
document endpoints let api consumers create, list, read, update, and delete documents in the user's account.
quick answer
use these endpoints when external workflows should sync drafts into hold your voice.
use this for
- creating a document from automation
- updating a saved draft
- reading a document for a client workflow
steps
- call `get /v1/documents` to list documents.
- call `post /v1/documents` with title and content to create.
- pass brand or profile id if the document should attach to a profile.
- call `put /v1/documents/:id` to update title or content.
- watch `_quota_charged` on large content swaps.
details to know
- create consumes one document slot.
- updates are free unless the content-swap guard treats the new body as a separate draft.
- documents created through the api appear in the web app.
limits and edge cases
- api keys need `documents:read` or `documents:write` scope.
- a document can only attach to a profile the user can access.
ready to use the product instead of reading about it?
open app