An open API service indexing awesome lists of open source software.

https://github.com/supermodeltools/docs

Save up to 40% on agent token costs with code graphs: call graphs, dependency graphs, dead code detection, and blast radius analysis.
https://github.com/supermodeltools/docs

api architecture architecture-docs code-graph developer-tools documentation static-analysis supermodel

Last synced: 7 days ago
JSON representation

Save up to 40% on agent token costs with code graphs: call graphs, dependency graphs, dead code detection, and blast radius analysis.

Awesome Lists containing this project

README

          

# Supermodel API Documentation

Source for the Supermodel API docs site: [docs.supermodeltools.com](https://docs.supermodeltools.com).

---

## ⭐ Star the Supermodel Ecosystem

If this is useful, please star our tools — it helps us grow:

[![mcp](https://img.shields.io/github/stars/supermodeltools/mcp?style=social)](https://github.com/supermodeltools/mcp)  [![mcpbr](https://img.shields.io/github/stars/supermodeltools/mcpbr?style=social)](https://github.com/supermodeltools/mcpbr)  [![typescript-sdk](https://img.shields.io/github/stars/supermodeltools/typescript-sdk?style=social)](https://github.com/supermodeltools/typescript-sdk)  [![arch-docs](https://img.shields.io/github/stars/supermodeltools/arch-docs?style=social)](https://github.com/supermodeltools/arch-docs)  [![dead-code-hunter](https://img.shields.io/github/stars/supermodeltools/dead-code-hunter?style=social)](https://github.com/supermodeltools/dead-code-hunter)  [![Uncompact](https://img.shields.io/github/stars/supermodeltools/Uncompact?style=social)](https://github.com/supermodeltools/Uncompact)

---

## Get an API key

**Save 40%+ on agent token costs — start free → [supermodeltools.com/trial](https://supermodeltools.com/trial)**

Send your API key in the `X-Api-Key` header.

## Quickstart

- **Docs**: [docs.supermodeltools.com](https://docs.supermodeltools.com)
- **OpenAPI spec (canonical)**: [`supermodeltools/openapi-spec`](https://github.com/supermodeltools/openapi-spec) (`openapi.yaml`)
- **TypeScript SDK**: [`supermodeltools/typescript-sdk`](https://github.com/supermodeltools/typescript-sdk)
- **MCP Server**: [`supermodeltools/mcp`](https://github.com/supermodeltools/mcp)

## Updating docs and API reference

- **Pages**: edit the MDX files in the repo root (`index.mdx`, `quickstart.mdx`, `authentication.mdx`, `concepts.mdx`).
- **API Reference**: this site is driven by the public OpenAPI spec in [`supermodeltools/openapi-spec`](https://github.com/supermodeltools/openapi-spec).

## Accuracy policy

- **Production-first**: examples should target `https://api.supermodeltools.com` and the Dashboard at [dashboard.supermodeltools.com](https://dashboard.supermodeltools.com/).
- **Spec mismatch?** If the API behavior differs from the spec, file an issue on [`supermodeltools/openapi-spec`](https://github.com/supermodeltools/openapi-spec).
- **Docs issue?** File an issue on this repo.

## Support

- **Email**: [engineers@supermodel.software](mailto:engineers@supermodel.software)

## Local development (docs repo only)

These instructions are only for previewing changes to `supermodel-api-docs` locally.

Install the `mint` CLI:

```bash
npm i -g mint
```

Run the dev server from this repo root (where `docs.json` lives):

```bash
mint dev
```

Preview at `http://localhost:3000`.