Actions71
- Asset Actions
- Attribute Actions
- Block Actions
- Database Actions
- Document Actions
- Markdown Table Actions
- Notebook Actions
- Search Actions
- System Actions
- Tag Actions
Document → Get ID by Path
AI-generatedSummary
Retrieve the document ID(s) corresponding to a human-readable document path within a specific notebook.
Inputs
- Notebook ID (required) — The unique ID of the notebook where the document resides.
- Document Path (required) — The folder-like path of the document, starting with '/'; for example, '/My Project/Meeting Notes'.
Output shape
An object containing the notebook ID, the queried path, an array of matching document IDs, the count of IDs found, a boolean indicating if any ID was found, and the first ID or null if none.
The operation returns multiple document IDs in case the path corresponds to more than one document. The main document ID is provided as the 'id' field, which is the first in the array or null if no documents are found.
Examples
Example 1: Get Document ID by Path
Provide the notebook ID and the document path to retrieve the corresponding document ID(s). The results include the count and an array of all matched IDs.