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: 
https://<your-server>/api
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.
  • Authentication is required for most endpoints — see Authentication.

​
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.