Skip to main content

API Reference

This section provides a reference to the Uberduck API using the OpenAPI specification. The OpenAPI specification is a standardized way to describe RESTful APIs, making it easier to understand and interact with our API.

Key Features​

  • Interactive Documentation: Test API endpoints directly from the browser
  • Request/Response Examples: See example requests and responses for each endpoint
  • Schema Definitions: Detailed information about data models and their properties

Getting Started​

The Uberduck API follows REST principles and uses standard HTTP methods. Authentication is handled using Bearer tokens which you can obtain from your Uberduck dashboard.

Start by exploring the available endpoints in the sidebar. Each endpoint documentation includes:

  • Method and URL
  • Path and query parameters
  • Request body schema (for POST/PUT requests)
  • Response schemas
  • Example requests and responses

Authentication​

All API requests require authentication using a Bearer token. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

For more details on authentication, visit the Authentication section.