---
title: "API Information"
method: GET
path: "/"
tags: ["System"]
---

# API Information

`GET /`

Returns basic API information and quick start guide.

## Response format
- **JSON**: For programmatic access
- **Plain text**: When called with curl/wget (developer-friendly)

## Response `200`

API information

- object
  - `name` string, required
  - `version` string, required
  - `message` string, required
  - `endpoints` object, required
    - `convert` string, required
    - `health` string, required
    - `docs` string, required
  - `authentication` string, required
  - `example` string, required
  - `links` object, required
    - `documentation` string, required
    - `github` string, required
    - `support` string, required

---

[API](https://skmtc.dev/superdoc-dev/apis/superdoc-api.md) · [All operations](https://skmtc.dev/superdoc-dev/apis/superdoc-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/superdoc-dev/superdoc-api/revisions/869ccb471697/schema)