OpenAPI

Tupel provides OpenAPI documentation to help you understand and integrate with our API as quickly as possible. Our OpenAPI specification includes complete details about all endpoints, request parameters, response schemas, and authentication requirements.

Interactive Documentation

We provide a Swagger UI interface that allows you to explore and test our API directly in your browser:

• Swagger UI: OpenAPI Schema

The interactive documentation allows you to:

• Browse all available endpoints
• See required parameters and request bodies
• Test API calls directly from your browser
• View response schemas and examples

OpenAPI Specification File

You can also download or directly reference our OpenAPI specification in JSON format:

• OpenAPI JSON: OpenAPI JSON File

Using with API Clients

Import our OpenAPI specification into your favorite API client to streamline your development process:

1. Postman - Click "Import" and select "Link"
   - Enter https://tupel.com/api/openapi.json
   - Configure your authentication credentials

2. Insomnia - Click "Create" → "Import From" → "URL"
   - Enter https://tupel.com/api/openapi.json
   - Set up your environment with your Organization ID and API Key

3. VS Code REST Client - Install the REST Client extension
   - Create a new .http file
   - Import the specification using the OpenAPI extension

Staying Updated

Our OpenAPI specification is automatically updated whenever we make changes to our API. Always reference the latest version to ensure you're working with the most current endpoints and schemas.

For questions about our API or OpenAPI specification, please contact developers@tupel.com.