Get document

A document or bullet with its child bullets, tags and flashcard markers.

GET https://cotlet.dev/api/v1/remnote/documents/{document_id}

read

Returns one document or bullet with its children in order, nested under their parent. Each bullet shows its tags and whether it is a flashcard and which type. Use depth to limit how deep the tree goes. Images are returned as references; their contents are not read.

Parameters

Parameters: get_document
NameTypeDescription
document_id string required string Document or note ID from search_notes or list_documents.
depth integer integer How many levels of children to return. Default: 3.

Request

cURL
curl https://cotlet.dev/api/v1/remnote/documents/document_8c41d2 \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("remnote", "get_document", {"document_id":"document_8c41d2"})
Node.js
const result = await cotlet.call('remnote', 'get_document', {"document_id":"document_8c41d2"});
CLI
cotlet call remnote get_document --data '{"document_id":"document_8c41d2"}'

Example response

JSON

{
  "document_id": "rem_8f21a0",
  "text": "Krebs cycle",
  "tags": [
    "Biology"
  ],
  "children": [
    {
      "document_id": "rem_2c77e1",
      "text": "Citrate >> first product of the cycle",
      "flashcard": "basic",
      "tags": [],
      "children": []
    },
    {
      "document_id": "rem_2c77e2",
      "text": "The cycle runs in the mitochondrial matrix",
      "flashcard": null,
      "tags": [],
      "children": []
    }
  ]
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.