Skip to content

New: DeepSeek V4.1 Flash Derisked. In chat and on the API.

See modelsWhat's newReport a bug
Open chat
API reference

API reference

Artifacts API

The documents, slide decks and designs of Vani Chat, as an API: create one from content or let a model write it, apply structured edits, keep versions, export to PDF, DOCX, PPTX, Markdown, HTML or JSON, and share a read-only link.

Base path
https://api.vani.ai/v1/artifacts
Kinds
document, slides, design
Keys
Plan-billed keys and signed-in sessions
Schema
GET https://api.vani.ai/v1/artifacts/schema
On this pageWho can use it

Who can use it

  • Keys created in Vani Chat (billed to the plan's allowance) and signed-in sessions. Prepaid API platform keys are not enabled yet and get 403 artifacts_api_unavailable.
  • Generating or revising with a model is billed like a chat request of that model; everything else (create from content, edit, versions, convert, export, share) is free and limited by your plan's artifact count.
  • GET /artifacts/config returns the kinds and limits enabled for your account; GET /artifacts/schema returns the JSON shapes and operations.

Endpoints

RequestWhat it does
GET /artifactsList (kind, conversation_id, q, limit, cursor).
POST /artifactsCreate from {kind, title, content}, or let a model write it: {kind, model, instructions} (billed).
GET · PATCH · DELETE /artifacts/{id}Read; save new content with base_version (conflicts are refused); delete (purged after 30 days).
POST /artifacts/{id}/editStructured operations (no model).
POST /artifacts/{id}/revise{model, instructions}: a model revises it (billed).
GET /artifacts/{id}/versions[/{v}] · POST …/restoreHistory and restore.
POST /artifacts/{id}/convert{to}: a new artifact of another kind.
GET /artifacts/{id}/export?format=pdf, docx, pptx, md, html or json.
POST /artifacts/{id}/assets · GET …/assets/{asset}Images inside an artifact.
POST · DELETE /artifacts/{id}/shareA read-only public link (where sharing is enabled).

More reference: OpenAI-compatible API · Anthropic-compatible API · Model ids, limits, headers and usage · Images and PDFs on the API · MCP tools on the API · Web search and web fetch tools · Media API: images and videos · Responses API: scope and limits · Model changes: webhooks, feeds and the changes API · API overview · Docs and quickstart