Skip to main content
The Dataerai REST API gives you programmatic access to the platform — organizations, projects, collections, assets and their content, datasets, transfers, permissions, groups, allocations, and grants. The pages in this section are generated from the API’s OpenAPI specification, and each endpoint has an interactive playground you can call from your browser.

​
Base URL

The API is served by your Dataerai deployment, with endpoints under /api. Use your deployment’s host:
Don’t hardcode a host in shared code — the CLI and SDKs use a DATAERAI_SERVER setting (see the CLI overview), and the API playground lets you set the server.

​
Requests and responses

  • Requests and responses use application/json.
  • List endpoints are paginated — most page through results with the page and page_size query parameters and return the total count and next/previous links in the response body. Check each endpoint’s page for its exact parameters.
  • Authentication is required for most endpoints — see Authentication.

​
OpenAPI specification

The reference in this section is generated from the API’s OpenAPI specification, published alongside these docs at openapi.yaml. You can feed that file to your own code generator or HTTP client.

​
Prefer a client?

For uploads, downloads, and metadata, the CLI and SDKs handle authentication, multipart transfers, and resumes for you. Use the REST API directly when you need full control or are integrating another system.

​
Next steps

Authentication

How to authenticate your API requests.