Get a document
Get a specific document by ID. This endpoint requires a Data Source ID. To get started:
- Go to the Connectors page
- Create a new API Connector
- Copy the data source ID from the connector details page
- Use this ID in the path parameter
Rate Limits
600 requests per minute.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the custom API data source.
ID of the document.
Query Parameters
Comma-separated list of fields to return. If not provided, only document IDs are returned.
id, title, content, content_type, url, document_created_at, document_updated_at, meta "id,title,content"
Response
Success
markdown, text, html Optional unique identifier for the document. We enforce uniqueness in our end. If not provided, a UUID will be generated automatically and returned in the response. Must be alphanumeric and can include underscores and hyphens. The order of the documents in the response is the same as the order of the documents in the request, so you can match any generated IDs.
^[a-zA-Z0-9_-]+$UTC timestamp in ISO 8601 format (e.g. '2024-03-20T10:00:00Z')
UTC timestamp in ISO 8601 format (e.g. '2024-03-20T10:00:00Z')
Email addresses of the users that have read access to the document. If not provided, the document can be seen by anyone in Realm. Cannot be an empty array — omit the field instead.
1When true, marks this document as verified for this upsert. Send true on every upsert while the source system still treats it as authoritative; omitting it or sending false stops asserting source verification.

