System
Machine-readable SDK and discovery manifest
A single machine-readable index for coding agents and tooling: the OpenAPI spec locations, the rendered documentation views, the authentication scheme, and both official SDKs (TypeScript and Python) with their real, current package name, registry, and version, read directly from each package’s own manifest at startup, see packages/api/src/routes/api-manifest.ts. Go and Java are reported as null: no SDK exists for those languages in this repository (see /sdks/other-languages on the documentation site). Exempt from caller authentication for the same reason GET /openapi.json is.
GET
/
api-manifest.json
Machine-readable SDK and discovery manifest
curl --request GET \
--url http://localhost:3000/api-manifest.jsonimport requests
url = "http://localhost:3000/api-manifest.json"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:3000/api-manifest.json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api-manifest.json",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api-manifest.json"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api-manifest.json")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api-manifest.json")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"name": "Parmana",
"apiVersion": "v1",
"buildVersion": "0.4.0",
"openapi": {
"json": "/openapi.json",
"yaml": "/openapi.yaml"
},
"documentation": {
"site": "https://docs.parmanasystems.com",
"swaggerUi": "/documentation",
"redoc": "/reference"
},
"authentication": {
"type": "bearer",
"header": "Authorization: Bearer <key>",
"docs": "https://docs.parmanasystems.com/api-reference/authentication"
},
"sdks": {
"typescript": {
"package": "@parmana/sdk",
"registry": "npm",
"version": "1.1.2",
"install": "npm install @parmana/sdk",
"docs": "https://docs.parmanasystems.com/sdks/typescript",
"reference": "https://docs.parmanasystems.com/sdks/reference/typescript/classes/ParmanaClient"
},
"python": {
"package": "parmana",
"registry": "pypi",
"version": "1.1.4",
"install": "pip install parmana",
"docs": "https://docs.parmanasystems.com/sdks/python",
"reference": "https://docs.parmanasystems.com/sdks/reference/python/client"
},
"go": null,
"java": null
},
"connectorSdks": {
"typescript": {
"package": "@parmana/connector-sdk",
"registry": "npm",
"version": "0.1.0",
"install": "npm install @parmana/connector-sdk",
"docs": "https://docs.parmanasystems.com/reference/connector-sdk"
},
"python": {
"package": "parmana-connector-sdk",
"registry": "pypi",
"version": "0.1.0",
"install": "pip install parmana-connector-sdk",
"docs": "https://docs.parmanasystems.com/reference/connector-sdk-python"
}
}
}Response
200 - application/json
The manifest, JSON.
The response is of type object.
⌘I
Machine-readable SDK and discovery manifest
curl --request GET \
--url http://localhost:3000/api-manifest.jsonimport requests
url = "http://localhost:3000/api-manifest.json"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:3000/api-manifest.json', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api-manifest.json",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/api-manifest.json"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/api-manifest.json")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api-manifest.json")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"name": "Parmana",
"apiVersion": "v1",
"buildVersion": "0.4.0",
"openapi": {
"json": "/openapi.json",
"yaml": "/openapi.yaml"
},
"documentation": {
"site": "https://docs.parmanasystems.com",
"swaggerUi": "/documentation",
"redoc": "/reference"
},
"authentication": {
"type": "bearer",
"header": "Authorization: Bearer <key>",
"docs": "https://docs.parmanasystems.com/api-reference/authentication"
},
"sdks": {
"typescript": {
"package": "@parmana/sdk",
"registry": "npm",
"version": "1.1.2",
"install": "npm install @parmana/sdk",
"docs": "https://docs.parmanasystems.com/sdks/typescript",
"reference": "https://docs.parmanasystems.com/sdks/reference/typescript/classes/ParmanaClient"
},
"python": {
"package": "parmana",
"registry": "pypi",
"version": "1.1.4",
"install": "pip install parmana",
"docs": "https://docs.parmanasystems.com/sdks/python",
"reference": "https://docs.parmanasystems.com/sdks/reference/python/client"
},
"go": null,
"java": null
},
"connectorSdks": {
"typescript": {
"package": "@parmana/connector-sdk",
"registry": "npm",
"version": "0.1.0",
"install": "npm install @parmana/connector-sdk",
"docs": "https://docs.parmanasystems.com/reference/connector-sdk"
},
"python": {
"package": "parmana-connector-sdk",
"registry": "pypi",
"version": "0.1.0",
"install": "pip install parmana-connector-sdk",
"docs": "https://docs.parmanasystems.com/reference/connector-sdk-python"
}
}
}