Sign in

v1

latestOpenAPI 3.1.12026-07-242899061.7 MB
Analyst Note

Lookup a specific Analyst Note

Retrieve a specific analyst note by its ID with configurable serialization level.

post/lookup/{note_id}

Path parameters

note_idstring required

Note id

Request body

tagged_textboolean

Determines if the <entity></entity> tags should be inline with entities in the note title and text.

escape_htmlboolean

Determines if HTML tags are escaped, applied only when tagged_text = true.

serialization'id' | 'min' | 'full'

Entity serialization level. When set to id, only the entity id will be included. Setting it to min leads to the id and name being included and setting it to full means that each entity will have the id, name, type and possibly a description included in the response.

Response

Detailed object of the note.

countinteger required
next_offsetstring