API Usage

This guide will help you import the Voxxi API OpenAPI schema into popular API clients like Postman and Insomnia, making it easier to explore, test, and integrate with our endpoints.

OpenAPI Schema

Voxxi provides a comprehensive OpenAPI (formerly Swagger) schema that describes all available endpoints, request parameters, response formats, and authentication requirements. Using this schema, you can automatically configure your API client with all Voxxi endpoints.

Schema Link

Using with Postman

Postman is a popular API development environment that supports OpenAPI schema imports for easy API exploration and testing.

Step 1: Import the OpenAPI Schema

1. Open Postman and click the Import button in the top-left corner
2. Select the Link tab
3. Enter the Voxxi OpenAPI schema URL: https://docs.voxxi.ai/openapi.json
4. Click Continue
5. Review the import settings and click Import

Step 2: Configure Authentication

1. After importing the schema, you'll need to set up authentication
2. Click on the Authorization tab in the request panel
3. Select Bearer Token from the Type dropdown
4. Enter your Voxxi API key in the Token field
5. For more details on obtaining and managing API keys, see Authentication

Step 3: Test Your Setup

1. Select any endpoint from the imported collection
2. Click Send to make a test request
3. Verify you receive a successful response

Postman Documentation:

• Importing OpenAPI schemas
• Using Bearer Token authentication
• Managing environments

Using with Insomnia

Insomnia is a powerful REST API client that provides excellent OpenAPI schema support and a clean interface for API testing.

Step 1: Import the OpenAPI Schema

1. Open Insomnia and create a new project or use an existing one
2. Click the Create dropdown and select Import from URL
3. Enter the Voxxi OpenAPI schema URL: https://docs.voxxi.ai/openapi.json
4. Click Fetch and Import
5. Review the import summary and click Import

Step 2: Configure Authentication

1. Click on the imported Voxxi API folder
2. Go to the Auth tab in the right panel
3. Select Bearer Token from the dropdown
4. Enter your API key in the Token field
5. The authentication will be applied to all requests in the collection
6. For more details on obtaining and managing API keys, see Authentication

Step 3: Test Your Setup

1. Select any endpoint from the imported requests
2. Click Send to make a test request
3. Review the response in the right panel

Insomnia Documentation:

• Importing OpenAPI specifications
• Bearer Token authentication
• Environment variables

Alternative Import Methods

Manual Download and Import

If you prefer to download the schema file first:

1. Download the schema: Right-click this link and save as voxxi-openapi.json
2. Import in Postman: Use the File tab in the import dialog
3. Import in Insomnia: Use Import from File option

Command Line Import (Advanced)

You can also use command-line tools to work with the OpenAPI schema:

# Download the schema
curl -o voxxi-openapi.json https://docs.voxxi.ai/openapi.json

# Validate the schema
swagger-codegen validate -i voxxi-openapi.json

# Generate client code (example for Python)
swagger-codegen generate -i voxxi-openapi.json -l python -o ./voxxi-python-client

Getting Help

If you encounter issues:

1. Check the API Status: Visit status.voxxi.ai for any ongoing issues
2. Review Documentation: Ensure you're following the correct import steps
3. Contact Support: Reach out with your specific error messages and steps taken