← Back to Dashboard

API Documentation

Generate synthetic documents, identities, and tabular datasets.

Base URL: https://symagedocs.ai/api/v1
Auth: Authorization: Bearer sk_live_YOUR_KEY
Rate limit: 10 requests/second per key

New here?Follow the Quick Start to generate your first document in under 2 minutes.

Forms Catalog

GET /api/v1/forms List available forms read
GET /api/v1/forms/{{form_id}} Form details with field definitions read

Document Generation

POST /api/v1/generate Create an async generation job generate
GET /api/v1/jobs List your jobs (paginated) read
GET /api/v1/jobs/{{job_id}} Job status and progress read
GET /api/v1/jobs/{{job_id}}/download/{{format}} Download output (json, csv, pdf_typed) read

Raw Identities

POST /api/v1/identities Generate synthetic identities as JSON (free) generate

Tabular Generation

POST /api/v1/tabular/parse NL description to column schema (LLM-powered) generate
POST /api/v1/tabular/generate Generate rows from explicit schema generate
GET /api/v1/tabular/{{job_id}}/status Job progress and ETA read
GET /api/v1/tabular/{{job_id}}/download/{{format}} Download CSV or JSON read

Batch Generation

Create batches with token budgets for controlled, bulk generation. Items are generated synchronously and downloadable via presigned URLs.

POST /api/v1/batches Create a batch generate
GET /api/v1/batches List your batches (paginated) read
GET /api/v1/batches/{{batch_id}} Batch status and details read
POST /api/v1/batches/{{batch_id}}/generate Generate items within a batch generate
GET /api/v1/batches/{{batch_id}}/items List batch items (paginated) read
GET /api/v1/batches/{{batch_id}}/items/{{item_id}}/download Presigned download URLs for item files read

Presigned Downloads

Get direct S3 download URLs instead of proxying files through the server.

GET /api/v1/jobs/{{job_id}}/downloads Presigned URLs for all job output files read

Account

GET /api/v1/account/balance Credit usage totals account
GET /api/v1/account/usage Usage summary by period account

API Keys

POST /api/internal/api-keys Create a new key session
GET /api/internal/api-keys List your keys session
DELETE /api/internal/api-keys/{{key_id}} Revoke a key session
POST /api/internal/api-keys/{{key_id}}/rotate Rotate a key session

Webhooks

Receive real-time notifications instead of polling. See the Webhooks guide for payload format, signature verification, and retry policy.

POST /api/v1/webhooks Register a webhook endpoint session
GET /api/v1/webhooks List your webhooks session
PATCH /api/v1/webhooks/{{webhook_id}} Update a webhook session
DELETE /api/v1/webhooks/{{webhook_id}} Disable a webhook session

Response Format

All endpoints return a consistent envelope:

{{
  "data": {{ ... }},
  "meta": {{
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "count": 5,
    "has_more": true,
    "next_cursor": "2026-03-24T10:00:00+00:00"
  }}
}}

Interactive Reference

Explore the auto-generated interactive API docs:
Swagger UI: Swagger UI
ReDoc: ReDoc
OpenAPI Spec: openapi.json