Basic Dremio REST API

Authenticate to Dremio REST APIs and submit SQL via curl.

Updated Mar 6, 2026
One-click install
npx skills add https://github.com/developer-advocacy-dremio/dremio-skills-bundle --skill basic-dremio-rest-api
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: Basic Dremio REST API
Source: https://github.com/developer-advocacy-dremio/dremio-skills-bundle/tree/main/basic-dremio-skill
Command: npx skills add https://github.com/developer-advocacy-dremio/dremio-skills-bundle --skill basic-dremio-rest-api

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many users and AI agents need a reliable, reproducible way to interact with Dremio programmatically, but struggle with authentication differences, API versioning, and the correct curl patterns for submitting SQL, polling jobs, and retrieving results. This Skill centralizes the required steps, environment variable conventions, and links to official docs so agents can build requests correctly and avoid common mistakes.

Core Features & Use Cases

  • Authentication guidance for Personal Access Tokens (PATs) and fallback login tokens for self-hosted instances.
  • Environment variable conventions and prompts to collect edition-specific values like DREMIO_URL, DREMIO_PAT, and DREMIO_CLOUD_PROJECT_ID.
  • Practical curl patterns for SQL submission, job polling, result retrieval, and catalog listing, plus references to the Dremio Software and Dremio Cloud API docs.
  • Use Case: Run an asynchronous SQL job against a Dremio cluster, poll for completion, and fetch the results programmatically using shell tools like curl and jq.

Quick Start

Authenticate to your Dremio instance using a PAT or login token, set the required environment variables for your edition, and run a catalog listing curl request to verify connectivity.

Frequently Asked Questions about Basic Dremio REST API

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I authenticate Dremio REST API calls using a personal access token?

Authenticate Dremio REST API calls by setting environment variables like DREMIO_PAT and DREMIO_URL, then passing the personal access token in your curl request headers. This Skill provides the exact header formats and variable conventions for both Dremio Software and Dremio Cloud.

What's the best way to submit SQL to Dremio via curl and retrieve the results?

Submit SQL to Dremio via curl by sending an asynchronous job request, polling the job status until completion, and fetching the results. This Skill outlines the complete workflow with practical curl patterns and references to official API documentation.

Does the Dremio REST API use different endpoints for Dremio Cloud and self-hosted Dremio Software?

Yes, Dremio Cloud uses the v0 API version while self-hosted Dremio Software uses the v3 API version. This Skill differentiates between the two editions and supplies the correct curl request formats and environment variables for each.

Can I use login tokens instead of a personal access token for Dremio API authentication?

Yes, you can use fallback login tokens for self-hosted Dremio instances if you do not have a personal access token. This Skill outlines the authentication guidance and curl patterns required for both PAT and login-token methods.

How do I list the catalog in Dremio using a REST API curl request?

List the Dremio catalog by sending an authenticated curl GET request to the catalog endpoint after setting your edition-specific environment variables. This Skill provides example curl requests to verify connectivity and retrieve catalog listings.

Why do my Dremio API curl requests fail due to missing environment variables?

Dremio API curl requests fail when required environment variables like DREMIO_URL, DREMIO_PAT, or DREMIO_CLOUD_PROJECT_ID are not set correctly. This Skill prompts you to collect edition-specific values and supplies the exact variable conventions to avoid common mistakes.