Interactive API Docs

Every dataset you upload gets its own auto-generated OpenAPI specification and interactive Swagger UI. Explore endpoints, inspect the schema, and run live queries from the browser — no docs to write.

What it does

Interactive API Docs are generated automatically for every dataset. The OpenAPI spec describes your exact column names and types, lists every supported query parameter, and provides example responses. The Swagger UI lets you explore those endpoints visually and run live 'Try it out' requests against your real data. You can also fetch the raw OpenAPI JSON for use with client generators, Postman, or third-party API tooling.

How it works

1. 1

   Upload your dataset

   The OpenAPI spec is generated as soon as your CSV is imported and column types are detected.

2. 2

   Open the Swagger UI

   Click 'API Docs' on any dataset detail page. You'll see every endpoint, every parameter, and example responses.

3. 3

   Try it out live

   Drop in your API key, fill in any query parameters, and execute the request directly from the browser. The response comes back inline.

4. 4

   Or fetch the raw spec

   GET /api/v1/datasets/:id/swagger returns the full OpenAPI JSON document — perfect for codegen, Postman, or Insomnia.

See it in action

# Fetch the raw OpenAPI spec for your dataset
curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://csv-api.com/api/v1/datasets/d_a8f3bc91/swagger"

{
  "openapi": "3.0.0",
  "info": { "title": "Customers API", "version": "1.0.0" },
  "paths": {
    "/api/v1/datasets/d_a8f3bc91/records": { ... }
  },
  "components": {
    "schemas": {
      "Customer": { "properties": { "name": {...}, "age": {...} } }
    }
  }
}

Why it matters

• Zero documentation work

  You never write a sentence of API docs. The spec stays accurate because it's generated from the dataset itself.

• Always in sync

  Rename a column or upload new data and the docs update automatically.

• Codegen-friendly

  OpenAPI is the lingua franca of API tooling. Generate clients in any language, import into Postman, plug into your favorite IDE.

Common use cases

• Onboarding new teammates to a dataset without a Slack thread

• Letting frontend devs explore the API while you work on the data side

• Generating typed clients for TypeScript, Python, Go, or any other language

• Sharing a dataset's contract with an external partner