Skip to main content

Overview

The Gaudio Developers API is RESTful and can be used in any environment that supports HTTP requests. Responses are returned in JSON format.

You can perform the following actions with this API:

  • File Upload: Upload files to be used for processing requests.
  • Job Creation: Create a new job
  • Job Status: Check the status of a created job

⚠️ All API requests require authentication.
For authentication methods and how to obtain a token, see the Authentication Guide.

Base URL​

All endpoints use a common base URL.

https://restapi.gaudiolab.io/developers/api

Each resource specifies its own version, and endpoints may have different versions.

API Version​

Gaudio Developers API uses Resource-Specific Versioning.

  • Each resource (URL) can have its own version (v1, v2, ...).
  • When new features are added or breaking changes are needed, a new version is created for that resource only.
  • Existing versions are maintained stably for a certain period.

Version Change Policy​

The following changes are provided in a backward-compatible manner within the same version:

  • Adding new resources (URLs)
  • Adding new API parameters
  • Adding new properties to response objects
  • Changing the order of properties in response objects
  • Changing the format or length of opaque strings such as Job IDs

Getting Started​

Understand the job flow, create requests, and see what a successful response looks like.