Skip to main content

Tooling overview

Everything on these pages is built against the real ConstellationOS API surface: POST /telemetry, GET /topology, GET /predictions, and the /health endpoints, authenticated with the x-api-key header. Each artifact encodes the actual limits and error envelopes the API enforces, so you can drop it into an integration and expect it to behave correctly under rate limits, batch caps, and partial failures.

What ships here:

ArtifactPageWhat it is
TypeScript clientSDK: TypeScriptSingle-file, zero-dependency, fetch-based client to copy into your codebase
Python clientSDK: PythonSingle-file client on requests with dataclasses and the same retry and batching semantics
Reference CLICLIOne vendorable Python file with health, topology, telemetry ingest, predictions, and smoke subcommands, suitable for cron and CI
Terraform examplesTerraformCustomer-side IaC: key storage in Secrets Manager, a scheduled telemetry ingester, and health monitoring with alarms
CloudFormation templateCloudFormationThe same two patterns as a single CFN template
Postman collectionPostmanImportable collection covering every endpoint, with variables for all three environments
OpenAPI documentOpenAPIContract-true OpenAPI 3.1 document for codegen and tooling

Base URLs and auth

All artifacts default to production and take the environment as configuration:

  • Production: https://api.constellation.space
  • Development: https://dev.api.constellation.space
  • Sandbox: https://sandbox.api.constellation.space

Every request except /health* requires your tenant API key in the x-api-key header. Tenant identity derives from the key, never from the hostname.

Packaging status

Packaged npm and PyPI SDKs and an installed CLI binary are on the roadmap; the vendorable single-file artifacts on these pages are the supported equivalents today. They are intentionally small enough to copy, review, and own inside your repository.