​

API Playground

Interactive testing environment for your Plati AI API

​

Overview

The API Playground provides an interactive environment where you can explore and test all the Plati AI API endpoints directly from the documentation. This feature allows you to:

• Craft API requests with your own parameters
• Submit requests and see real-time responses
• Test different authentication methods
• Explore response structures with proper formatting

​

Using the API Playground

The API Playground is enabled on all endpoints in our API Reference section. To use it:

1. Navigate to any endpoint documentation page
2. Find the interactive playground section below the endpoint description
3. Modify the request parameters as needed
4. Click “Try it out” to execute the request
5. View the response in the formatted output panel

​

Authentication

To test authenticated endpoints, you’ll need to add your API keys in the playground:

1. Click the “Auth” button in the playground header
2. Select the authentication type (Bearer Token or API Key)
3. Enter your credentials
4. Click “Save” to apply authentication to your requests

​

Code Examples

The playground automatically generates code snippets for your configured request in multiple languages:

• cURL
• Python
• JavaScript/Node.js

These code snippets update dynamically as you modify your request parameters, so you can easily copy and paste them into your own applications.

​

Best Practices

• Use Test Data: When testing endpoints that create, update, or delete resources, use test data to avoid affecting your production environment.
• API Key Security: Never share screenshots or recordings that include your API keys.
• Rate Limiting: Be aware that requests made through the playground count toward your API rate limits.