Annotations
Add an annotation
POST
A title and a date, with an optional endDate for a range, kind (release, post, content, incident or other, the default), note and url. A calendar date means its start in UTC. endDate may not be before date.
AuthorizationBearer <token>
An API token from POST /v2/tokens (at_live_...), or a project's secret key (sk_...) for server-side ingest.
In: header
Path Parameters
project*string
The project id, as listed by GET /v2/projects.
Length
1 <= lengthSend endDate to mark a span; it cannot be before date.
TypeScript Definitions
Use the request body type in TypeScript.
Send endDate to mark a span; it cannot be before date.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v2/projects/string/annotations" \ -H "Content-Type: application/json" \ -d '{ "title": "v2.0 released", "date": "2026-10-01T09:30:00.000Z", "kind": "release", "note": "New pricing page and onboarding flow.", "url": "https://github.com/remcostoeten/skriuw/releases/tag/v2.0.0" }'{ "data": { "id": "ann_0192f0c4-3b1e-7d2a-9c4f-1a2b3c4d5e6f", "project": "skriuw", "title": "API outage", "date": "2026-09-30T14:00:00.000Z", "endDate": "2026-09-30T16:15:00.000Z", "kind": "incident", "note": "Database failover; ingest kept running.", "url": null, "createdAt": "2026-09-30T17:00:00.000Z", "updatedAt": "2026-09-30T17:00:00.000Z" }}