Overview - Graphy SDK

AI Agents is currently in alpha. APIs may change.

Graphy AI Agents create, transform, and analyze charts using natural language. Most agents take a GraphConfig and a prompt and return an updated GraphConfig ready to render.

Architecture

Agents are stateless. Each request contains the full context needed to process it—no sessions, no conversation history. This design simplifies integration:

No session management or cleanup
Requests are idempotent and cacheable
Easy to retry on failure
Works with any architecture (serverless, edge, traditional)

Available Agents

Agent	Endpoint	SDK Method	Description
Chart Maker	`POST /api/v0/generate`	`generateGraph()`	Modify chart type, styling, and data transformations
Suggestions	`POST /api/v0/suggestions`	`generateSuggestions()`	Suggest chart types and data preparations
Mutation	`POST /api/v0/mutate`	`generateMutation()`	Transform the dataset — filter, group, derive, sort
Annotation	`POST /api/v0/annotate`	`generateAnnotations()`	Add highlights, tooltips, and other annotations
Narrative	`POST /api/v0/narrate`	`generateNarrative()`	Write the chart title, subtitle, and caption
Extract	`POST /api/v0/extract`	`extractFromProse()`	Build a dataset from text, images, PDFs, or spreadsheets

Prerequisites

A Graphy API key — create one in the console
Familiarity with GraphConfig (schema reference)

Integration Options

TypeScript SDK — Full-featured client with streaming, retries, and type validation.

import { GraphyAiSdk } from '@graphysdk/agents-sdk';

const ai = new GraphyAiSdk({
  apiKey: 'your-api-key',
  baseUrl: 'https://agents.graphy.dev',
});

const result = await ai.generateGraph({
  config: myGraphConfig,
  userPrompt: 'Change to a stacked bar chart',
});

REST API — Direct HTTP integration for any language. Returns Server-Sent Events for streaming progress.

curl -N https://agents.graphy.dev/api/v0/generate \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"config": {...}, "userPrompt": "Add a trend line"}'

Next Steps

Quickstart

First working call in 5 minutes

TypeScript SDK

Install and configure the SDK

REST API

Direct HTTP integration

Type Reference

Complete type definitions

​Architecture

​Available Agents

​Prerequisites

​Integration Options

​Next Steps

Quickstart

TypeScript SDK

REST API

Type Reference

Architecture

Available Agents

Prerequisites

Integration Options

Next Steps