Spec
Generated HTTP reference for the 2 operations the published OpenAPI document describes under openapi.json.
1 min read
Spec
This page is generated from the published OpenAPI document. It is complete with respect to that document and says nothing about surfaces the document does not describe yet. See what is generated here for what that means.
Base URL: https://api.codespar.dev
None of the operations below takes a credential: the published document declares them open. See Authentication for the rest of the API.
GET /openapi.json
GET
https://api.codespar.dev/openapi.jsonNo credential
This document
Responses
| Status | Body | Description |
|---|---|---|
200 | object | OK |
Example request
curl -X GET https://api.codespar.dev/openapi.json \
-H "Authorization: Bearer $CODESPAR_API_KEY"const res = await fetch("https://api.codespar.dev/openapi.json", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CODESPAR_API_KEY}`,
},
});
const data = await res.json();GET /v1/openapi.json
GET
https://api.codespar.dev/v1/openapi.jsonNo credential
This document, under the /v1 mount
Responses
| Status | Body | Description |
|---|---|---|
200 | object | OK |
Example request
curl -X GET https://api.codespar.dev/v1/openapi.json \
-H "Authorization: Bearer $CODESPAR_API_KEY"const res = await fetch("https://api.codespar.dev/v1/openapi.json", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.CODESPAR_API_KEY}`,
},
});
const data = await res.json();