API Reference
Deep dive into the BHB Platform's response structures and data models.
NotesResponse
The main response object returned by the analysis endpoint. It provides a multi-layered view of your document.
complete_document
The core analysis payload containing text and identified notes.
sentences: (Array of strings) The original document segmented into clean sentences.notes: (Array of objects) AI-extracted insights linked to specific sentence ranges.errata: (Array of strings) Any warnings or parsing issues encountered.
Note Object
Each item in the notes array represents a specific extraction.
| Property | Description |
|---|---|
| text | The raw text of the note. |
| nIn | The source text from which the note was derived. |
| nOut | The normalized or "clean" version of the note. |
| tokens | Detailed linguistic metadata for each word (lemma, gender, etc). |
Statistics & Metadata
sentenceCount
Integer
noteCount
Integer
Copyright
String
Credit
String