Analyst Notes: Preview

post

https://api.recordedfuture.com/analyst-note/preview

Preview a rendered analyst note with entity resolution without saving it.

Body Params

attributes

required

source

string

Entity id for note source.

tagged_text

boolean

Defaults to false

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

escape_html

boolean

Defaults to false

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

serialization

string

enum

Defaults to 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.

Allowed:

events

array

events

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Note object as shown if published

400Invalid request