TickOS
Tools

OpenAPI spec

.md

Machine-readable specification of the full API.

The complete API is described by an OpenAPI 3.1 specification, served publicly (no authentication) at:

terminal
Bash
01https://api.tickos.dev/v1/openapi.json
UTF-8 · LF · Bashtickos.dev

What you can do with it

  • Import it into Postman, Insomnia or Bruno to get a ready-to-use collection.
  • Render it with Swagger UI or Scalar for a browsable reference.
  • Generate typed clients with openapi-generator or openapi-typescript.
Generate TypeScript types
Bash
01npx openapi-typescript https://api.tickos.dev/v1/openapi.json \
02  -o tickos-api.d.ts
UTF-8 · LF · Bashtickos.dev
The Playground is generated from this spec, so every operation it lists can be tried there with a Send button. These guides are written separately and add context the spec does not cover (behaviors, limits and examples).
PreviousSMTP relay