AI23

Alert Calibration8

Alerts43

AnnotationQueues12

Annotations1

post/api/{org_id}/annotationsAnnotate a span, trace, or session

Announcements3

Anomaly Detection10

Auth3

AWS Marketplace2

Azure Marketplace1

Billings7

Clusters1

Dashboards16

Datasets14

Discovery1

Domain Management2

Downtimes12

EvalJobs10

Experiments17

Fleet36

Folders12

Functions10

GenAI Settings5

Groups6

Incidents28

Ingestion1

Keys6

KV4

License4

LLM9

Logs8

MCP2

Meta2

Metrics20

OnCall76

Organizations67

Patterns1

Pipelines16

Playground4

Product Analytics14

Profiles8

Prompts16

Providers6

Public Dashboards14

Query History5

Ratelimit4

RemoteTasks22

RePattern8

Reports18

Resources1

Roles8

Rum3

Sample Data3

Saved Views5

ScoreConfigs10

Scorers8

Search18

Search Jobs7

Service Streams6

ServiceAccounts5

Short Url2

Slack36

SLOs10

Sourcemaps5

Status Pages22

Streams10

Synthetics45

Templates8

Traces31

Users13

Workflows12

Annotations

Annotate a span, trace, or session

Validates values against immutable Score Config versions and writes one annotation-source event per Score to the _llm_scores stream.

post/api/{org_id}/annotations

Request

Base URL
https://api.openobserve.ai (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/openobserve/apis/openobserve-api-http/docs/api/:org_id/annotations/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

org_idstring required

Organization name

Request body

metadataunknown

refTimestampinteger required

Original evaluated object's timestamp in microseconds.

scopestring required

Evaluated target scope: span, trace, or session.

sessionIdstring nullable

Optional parent context for span/trace annotations.

sourceStreamstring required

Trace stream containing the evaluated target.

targetIdstring required

Span ID, trace ID, or session ID according to scope.

traceIdstring nullable

Required for span annotations; optional context for trace annotations.

Response

annotatedAtinteger required

annotationIdstring required

scoreIdsstring[] required

Changes

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