OpenAPI specification
Download the OpenAPI 3.1.0 document for the Samva API and generate clients from it.
The Samva API publishes an OpenAPI 3.1.0 document. Use it to generate a client, inspect operations, or import the API into a tool.
Access the specification
The OpenAPI document is available at:
https://api.samva.dev/v1/openapi.jsonFor development:
https://api.samva.localhost/v1/openapi.jsonUse the specification
Interactive documentation
You can use tools like Swagger UI or Scalar to explore the API:
- Download the OpenAPI document from
/v1/openapi.json - Import it into Swagger UI, Postman, or your preferred API tool
- Explore endpoints, schemas, and examples
Code generation
Generate client libraries for your preferred language:
TypeScript/JavaScript.
npx @hey-api/openapi-ts -i https://api.samva.dev/v1/openapi.json -o ./src/clientPython.
openapi-generator generate -i https://api.samva.dev/v1/openapi.json -g python -o ./python-clientGo.
openapi-generator generate -i https://api.samva.dev/v1/openapi.json -g go -o ./go-clientPostman collection
Samva also publishes an official Postman collection derived from this OpenAPI document:
- Open Postman
- Click Import
- Select Link and enter:
https://api.samva.dev/v1/postman.json - Import the collection
The served collection updates with the public API, but an import into Postman is a snapshot. Reimport it to refresh your local collection.
Specification details
The OpenAPI document includes:
- All exported SDK endpoints. Authenticated and public HttpApi operations in the generated SDK surface.
- Request and response schemas.
- API key authentication details.
- Request and response examples.
- Error schema documentation.
SDK generation
The official Samva TypeScript SDK is generated from this OpenAPI document:
npm install samva