OpenAPI and schemas

Two endpoints expose the machine-readable API description and JSON Schema for test data. Use them to generate clients, validate payloads, or integrate with OpenAPI tooling.

OpenAPI spec endpoint

Requires an API key in the x-api-key header, a signed-in console session or an MCP access token. Returns the OpenAPI 3.1 description of every action an API key can reach. Request bodies and query parameters are generated from the same Zod schemas the server validates with. Each operation lists the key scopes it requires under security (for example apiKey: ["tests:run", "tests:read"]). Session-only actions are not listed.

https://api.smoothdeploy.com/v1/openapi.json

curl -H "x-api-key: $SMOOTHDEPLOY_API_KEY" https://api.smoothdeploy.com/v1/openapi.json -o openapi.json

Use the spec to generate a typed client, import it into Postman or Insomnia, or validate requests and responses in tests.

JSON Schema endpoint

Requires an API key, like the spec endpoint. Returns a JSON Schema document describing the test configuration format. The schema includes $defs for TestFile (a test file in the import and export ZIP format), TestConfigSchema (the config object accepted by tests.create and tests.update) and StepSchema (the step objects in a test file's steps array).

https://api.smoothdeploy.com/v1/schemas/test.json

curl -H "x-api-key: $SMOOTHDEPLOY_API_KEY" https://api.smoothdeploy.com/v1/schemas/test.json | jq '.$defs | keys'

Generating a client

With the spec downloaded, generate a typed TypeScript client using openapi-generator-cli:

npx @openapitools/openapi-generator-cli generate \
  -i ./openapi.json \
  -g typescript-fetch \
  -o ./src/smoothdeploy-client

Or use any OpenAPI 3.x-compatible generator. Popular options: openapi-typescript (type declarations only), orval (React Query hooks), kiota (Microsoft SDK generator).