v1

latestOpenAPI 3.1.12026-07-242899061.7 MB

Analyst Note

Publish an Analyst Note

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

post/publish

Request body

sourcestring uuid required

Identity of the 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.

note_idstring

The id of an existing note to edit.

resolve_entitiesboolean

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

Example request

{
  "attributes": {
    "topic": [
      "h4G-3N"
    ],
    "validated_on": "2025-03-21T12:00:00.000Z",
    "recommended_queries_obj": [
      {
        "url": "url:https://example.com/query"
      }
    ]
  },
  "note_id": "doc:vvpzg4",
  "attachment_content_details": {
    "content_type": "text/plain",
    "encoding": "utf-8"
  }
}

Response

Note id of the published note.

note_idstring required