Analyst Notes: Publish

post

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

Publish an analyst note, making it visible to your organization.

What this endpoint does

Publishes an analyst note, making it visible to your organization and discoverable through Analyst Notes: Search. This is the primary endpoint for creating production analyst notes — unlike Analyst Notes: Draft, published notes are immediately live.

The request body requires a source, note attributes (title, text, entity references, topic, and optional validation URLs), and supports resolve_entities for automatic entity linking.

Response data

A report_id string identifying the published note. Use this ID with Analyst Notes: Lookup to retrieve the full published content.

Body Params

attributes

required

source

string

required

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:

note_id

string

The id of an existing note to edit.

resolve_entities

boolean

Defaults to true

Determines if the entity resolver should be used on the note title and text for automated tagging of entities.

attachment_content_details

object

Attachments are only allowed for Recorded Future notes sources

events

array

events

Responses

What this endpoint does

Response data

200Note id of the published note.

400Invalid request