SDKs & Client Libraries

OpenAPI Specification

The TheTerms API publishes an OpenAPI 3.1 specification at:

https://app.theterms.app/api/v1/openapi.json

Use this spec to generate type-safe client libraries in any language.

Generating a Client

# Using openapi-typescript for type-safe types
npx openapi-typescript https://app.theterms.app/api/v1/openapi.json -o theterms-api.d.ts

# Or generate a full client with openapi-fetch
npm install openapi-fetch
npx openapi-typescript https://app.theterms.app/api/v1/openapi.json -o theterms-api.d.ts

import createClient from "openapi-fetch";
import type { paths } from "./theterms-api";

const client = createClient<paths>({
  baseUrl: "https://app.theterms.app/api/v1",
  headers: { "X-Api-Key": process.env.THETERMS_API_KEY },
});

const { data } = await client.GET("/containers");
// data is fully typed

pip install openapi-python-client
openapi-python-client generate \
  --url https://app.theterms.app/api/v1/openapi.json

Use OpenAPI Generator for 50+ languages:

npx @openapitools/openapi-generator-cli generate \
  -i https://app.theterms.app/api/v1/openapi.json \
  -g <language> \
  -o ./theterms-client

Replace <language> with go, ruby, java, csharp, rust, php, etc.

Official SDKs

Official first-party SDKs are on the roadmap:

Language	Package	Status
TypeScript/JavaScript	`@theterms/sdk`	Planned
Python	`theterms`	Planned

In the meantime, the OpenAPI spec provides everything needed to generate a fully typed client in your preferred language.