|
1 | 1 | # Supermodel OpenAPI Specification |
2 | 2 |
|
3 | | -[](https://www.npmjs.com/package/@supermodeltools/openapi-spec) |
4 | | -[](https://spec.openapis.org/oas/v3.0.0) |
5 | | -[](https://github.com/supermodeltools/openapi-spec/actions/workflows/validate.yml) |
6 | | - |
7 | | -OpenAPI 3.0 specification for the [Supermodel API](https://docs.supermodeltools.com) - code graphing and static analysis. |
8 | | - |
9 | | ---- |
10 | | - |
11 | | -## ⭐ Star the Supermodel Ecosystem |
12 | | - |
13 | | -If this is useful, please star our tools — it helps us grow: |
14 | | - |
15 | | -[](https://github.com/supermodeltools/mcp) [](https://github.com/supermodeltools/mcpbr) [](https://github.com/supermodeltools/typescript-sdk) [](https://github.com/supermodeltools/arch-docs) [](https://github.com/supermodeltools/dead-code-hunter) [](https://github.com/supermodeltools/Uncompact) [](https://github.com/supermodeltools/narsil-mcp) |
16 | | - |
17 | | ---- |
18 | | - |
19 | | -## Install |
20 | | - |
21 | | -```bash |
22 | | -npm install @supermodeltools/openapi-spec |
23 | | -``` |
24 | | - |
25 | | -The spec is available at `node_modules/@supermodeltools/openapi-spec/openapi.yaml`. |
26 | | - |
27 | | -## Endpoints |
28 | | - |
29 | | -| Method | Path | Description | |
30 | | -|--------|------|-------------| |
31 | | -| POST | `/v1/graphs/dependency` | File-level dependency graph | |
32 | | -| POST | `/v1/graphs/call` | Function-level call graph | |
33 | | -| POST | `/v1/graphs/domain` | Domain model classification | |
34 | | -| POST | `/v1/graphs/parse` | AST parse tree relationships | |
35 | | -| POST | `/v1/graphs/supermodel` | Full Supermodel IR bundle | |
36 | | - |
37 | | -All endpoints accept a zipped repository snapshot and return graph data as JSON. |
38 | | - |
39 | | -## Authentication |
40 | | - |
41 | | -Requests require an API key via `X-Api-Key` header. Get your key from the [Supermodel Dashboard](https://dashboard.supermodeltools.com). |
42 | | - |
43 | | -## Links |
44 | | - |
45 | | -- [API Documentation](https://docs.supermodeltools.com) |
46 | | -- [API Terms of Service](https://supermodeltools.com/legal/api-terms) |
| 3 | +> **This repository is archived.** |
| 4 | +> |
| 5 | +> The live spec is served directly from the API: |
| 6 | +> |
| 7 | +> https://api.supermodeltools.com/openapi.yaml |
0 commit comments