RErecordedfuture
Analyst Note

Preview an Analyst Note

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

post/preview

Request

  • Base URL
    https://api.recordedfuture.com/analyst-note
  • URL
    https://api.recordedfuture.com/analyst-note/preview
  • Auth
    • API key in header X-RFToken
    • or OAuth 2
      Authorization code: https://id.recordedfuture.com/authorize
      Token URL: https://id.recordedfuture.com/token

Request body

sourcestring

Entity id for note source.

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.

Example request

{
  "attributes": {
    "topic": [
      "h4G-3N"
    ],
    "validated_on": "2025-03-21T12:00:00.000Z",
    "recommended_queries_obj": [
      {
        "url": "url:https://example.com/query"
      }
    ]
  },
  "source": "source:VKz42X"
}

Response

Note object as shown if published

Example response

{
  "attributes": {
    "validated_on": "2025-03-21T12:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.