Skip to main content
POST
/
api
/
v0
/
annotate
Annotation Agent
curl --request POST \
  --url https://agents.graphy.dev/api/v0/annotate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "type": "column",
    "data": {
      "columns": [
        {
          "key": "month",
          "label": "Month"
        },
        {
          "key": "revenue",
          "label": "Revenue"
        }
      ],
      "rows": [
        {
          "month": "Jan",
          "revenue": 100
        },
        {
          "month": "Feb",
          "revenue": 140
        },
        {
          "month": "Mar",
          "revenue": 220
        }
      ]
    }
  },
  "userPrompt": "Highlight the March peak and add a tooltip explaining it",
  "metadata": {
    "callId": "req-annotate-1",
    "locale": "EN_US"
  }
}
'
{
  "message": "<string>"
}
Add highlights, tooltips, stickers, and other annotations to a chart with natural language. Send a GraphConfig and a prompt, receive an updated GraphConfig via Server-Sent Events.

​
Response

The response is a Server-Sent Events stream. See SSE Format for parsing details. 
event: progress
data: {"message":"Adding annotations..."}

event: complete
data: {"config":{...},"response":{"message":"Highlighted the March peak","steps":["Added highlight","Added tooltip"]}}
Final response data: 
interface AnnotateResponse {
  config: GraphConfig;
  response: {
    message: string;
    steps?: string[];
  };
}

​
HTTP Status Codes

StatusDescription
200Success (stream begins)
400Invalid request body
401Invalid or missing API key
429Rate limit exceeded
500Internal server error
Errors may also arrive as SSE events within a 200 response. See Error Codes.

Authorizations

​
Authorization
string
header
required

Your Graphy API key

Body

application/json
​
config
object
required

The graph configuration object used to render charts. See Graph Config Schema for the complete reference.

​
userPrompt
string
required

Natural language instruction describing the desired changes

Maximum string length: 10000
​
metadata
object

Optional tracking information for requests

Response

SSE stream with progress and completion events

SSE event name is "progress"

​
message
string