Skip to content
Open Breno

Documents

List items with filters and paging, read one, get its full text, and read a note's content, with the fields of an item.

An item is called a document in the API. These are the read operations (scope read).

List items#

http
GET /api/v1/documents
ParameterMeaning
source_typeOne of upload, note, link, meeting, voice, photo, import, connector.
statusqueued, processing, completed or failed.
space_idOnly items in this space.
tagOnly items with this tag.
ownerA user id, or me.
qTitle contains this text.
updated_sinceItems changed on or after this instant (RFC 3339).
limitPage size, up to 200.
offsetWhere to start.
Notes changed this week, yours only
curl -s -H "Authorization: Bearer $TOKEN" \
  "$BRENO/documents?source_type=note&owner=me&updated_since=2026-10-01T00:00:00Z&limit=50"

An invalid filter returns 400 INVALID_FILTER.

List items as cards#

http
GET /api/v1/documents/cards

The same list, with a summary, word count and connections for each item, for interfaces that show cards.

Get one#

http
GET /api/v1/documents/{id}

Returns the item and what you may do with it. A missing item, and one you cannot read, both return 404 NOT_FOUND, so a token cannot discover that something exists.

Full text#

http
GET /api/v1/documents/{id}/text

The full extracted text of any item you can read.

A note's content#

http
GET /api/v1/documents/{id}/content

The saved content of a note, as block JSON with a plain-text fallback. Notes only; it returns 403 for items that are read-only.

The item#

FieldMeaning
id, titleIdentity.
statusqueued, processing, completed or failed.
failure_reasonWhy, when status is failed.
enrichment_warningThe item is searchable, but summary, entity or tag enrichment failed or was partial.
source_typeHow it arrived (see the filter above).
sourceProvenance for a synced item: provider, connection_name, url, author, updated_at, synced_at, syncing.
ownerWho added it; null for legacy items and connector items with no known creator.
visibilityworkspace or private (readable by the owner only).
sensitivitypublic, internal, confidential or restricted.
space_idIts space; absent for items in the workspace commons.
tagsIts tags.
original_filename, mime_type, size_bytesFile details, for uploads.
content_editableTrue for notes and plain Markdown or text items.
can_edit, can_delete, is_ownerWhat the caller may do (on single-item reads).
created_at, updated_atTimes.

The exact schema is in the OpenAPI document.