Go back

Introduction to Polydata API

Welcome to the official Polydata API documentation. Whether you’re looking to integrate Polydata into your application, automate workflows, or analyze datasets seamlessly, our API offers powerful tools to meet your needs.


Getting Started

Step 1: Create Your Polydata Account

• If you don’t have an account yet, sign up on Polydata to get started.

Step 2: Access Your API Key

• After logging in, navigate to your dashboard to find your API key under the “API Access” section. Keep this key secure as it authorizes your requests.

Step 3: Install Postman for API Testing (Optional)

• For advanced users, we recommend using Postman for testing and exploring API endpoints. You can directly access our Postman Collection to get started quickly.


Authentication

How to Authenticate Your API Requests:

All requests must include your API key in the header. Here’s how to structure it:

Authorization: Bearer YOUR_API_KEY

Example in cURL:

curl -X GET "https://api.polydata.app/endpoint" -H "Authorization: Bearer YOUR_API_KEY"

Key Endpoints Overview


1. Fetching Data

• GET /data: Retrieve your stored datasets.

2. Sending Data

• POST /data: Send new datasets for processing.

3. Automating Workflows

• POST /workflows: Trigger automated workflows with custom configurations.

For more detailed endpoint information, visit our complete API reference.

Using Polydata API with Postman


Step 1:
Download and install Postman from here.

Step 2: Import our Postman Collection for ready-to-use API requests.

Step 3: Add your API key in the Authorization tab and start making requests effortlessly.

Troubleshooting and FAQs

Why am I getting a 401 Unauthorized error?

Make sure your API key is correct and included in the Authorization header.

How can I increase my API rate limits?

Contact our support team at support@polydata.app for enterprise solutions.

Get in Touch

For further assistance, reach out to us at support@polydata.app or join our developer community to exchange ideas and solutions with other Polydata users.