Annotations

Create an annotation

Create a new annotation on a workflow node with content type, visibility, and audit trail.

post/api/v1/annotations

Request

  • Base URL: https://numonic.ai
  • URL: https://numonic.ai/api/v1/annotations
  • Auth: API key in header x-api-key

Headers

X-Tenant-IDstring uuid required

Target tenant UUID. Required when API key has access to multiple tenants.

Example:fd32351e-ddfc-4800-9182-cb16e0bc5f5b

Request body

workflow_node_idstring required

Workflow node ID (hash key) to annotate

contentstring required

Annotation text content

content_type'text' | 'markdown' | 'json'

Content format type

visibility'private' | 'team' | 'public'

Visibility level: private (author only), team (tenant), public (all)

Response

Annotation created

messagestring required

Human-readable success message

Example response

{
  "message": "Operation completed successfully"
}

Changes

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