Powerdrill

Documentation

Enterprise

API Reference

Developer Guides

Get Started

GitHub

Obtains information about the specified subscription.

Get subscription

The end time of the current billing cycle.

The start time of the current billing cycle.

The payment mode. Possible values are:
- `ONE_TIME`: A single, upfront payment without recurring charges.
- `RECURRING`: A recurring payment setup, billed at regular intervals (e.g., monthly).

The subscription status. Possible values are:
- `incomplete_checkout`: The payment is pending.
- `active`: The subscription is currently active.
- `past_due`: The subscription is overdue but within the grace period.
- `fail`: Subscription failed.

The target type. Possible values are:
- `TEAM_WORKSPACE_CAPACITY`: Workspace capacity plans.
- `PROJECT_GENERAL_MODE_PLAN`: Plans for jobs that run in general mode.
- `AGENT_MODE_PLAN`: Plans for jobs that run in data agent mode.

The pricing plan. Possible values vary based on the value of `targetType`:
- When `targetType` is set to `AGENT_MODE_PLAN`, possible values are **BASIC**, **PLUS**, and **PRO**.
- When `targetType` is set to `WORKSPACE_CAPACITY`, possible values are **TIER1**, **TIER2**, **TIER3**, **TIER4**, and **TIER5**.
- When `targetType` is set to `PROJECT_GENERAL_MODEL_PLAN`, possible values are **TIER1**, **TIER2**, **TIER3**, **TIER4**, and **TIER5**.

apikey header x pd api key

Introduction

A quickest way to bring your data into intelligence

Try Out Powerdrill in Minutes

Gives full play to the value of your data

Advanced Analytics

Transforms your files into clear, organized presentations, reducing hours of work to minutes

AI Presentation Maker

Generate high-quality data report in one click

AI Report Generator

Well-organized references, curated mind maps, and other info that help you understand your data

Smart DocMap

Delivers smarter and more accurate answers to questions based on your datasets than ChatGPT

Chat App over Dataset

Offers a no-code approach to building apps by using natural language

No-Code App Builder

Enables you to share your datasets in an easy, governed manner

Dataset Sharing

Create a shared link to your chat and share it with others

Chat Sharing

Discover

Understands images, generates images based on prompts, converts text to audio, and converts audio to text.

Multimedia Input/Output

Best practices for using Powerdrill AI to analyze Excel files

Excel AI Analysis Best Practices

Privacy Notice

Terms of Service

A brief introduction about Powerdrill Enterprise and how to choose the right solution

Introducing Powerdrill Enterprise

Pricing

Jobs are data tasks effortlessly handled by Powerdrill through natural language conversations

What Is Job?

Overview of Powerdrill Enterprise API endpoints and capabilities

Overview

Start using Powerdrill Enterprise today and transform hours of data work into just minutes

Quick Start

Streaming

Creates a dataset. 
A dataset is a collection of data sources organized for specific purposes. You can create multiple datasets to group and store data sources based on different needs.

Create dataset

Datasets are stateless. This endpoint allows you to check the current statuses of data sources in the specified dataset to determine if the dataset is ready for running your jobs. 

A dataset is fully synchronized only when both `invalidCount` and `synchingCount` in the response are `0`. Otherwise, the data sources that are not synchronized cannot be accessed.

Get dataset status

Lists datasets in your team or of the specified name.

List datasets

Modifies information about the specified dataset.

Modify dataset

Deletes the specified dataset. Once deleted, all data sources within the dataset will also be permanently removed and cannot be recovered.

Delete dataset

Creates a data source in the specified dataset. 


Create data source

Creates a data source without specifying a dataset. Powerdrill will automatically create a dataset for it.

Create data source without specifying a dataset

Obtains information about the specified data source.

Get data source

Lists data sources contained in the specified dataset.

List data sources

Deletes the specified data source from the specified dataset. Once deleted, the data source cannot be recovered.

Delete data source

Generates a presigned URL to access the specified data source.

Presign data source 

Upload file

Creates a session. 
A session refers to the continuous interaction between the user and Powerdrill within a conversation. Your team can have up to 150 sessions simultaneously. If the limit is reached, you can remove unnecessary sessions to make space for new ones.

Create session

Obtains information about the specified session.

Get session

Obtains the job history contained in the specified session.

Get job history in session

List sessions

Modifies the configuration of the specified session.

Modify session

Deletes a session. Once deleted, both the session and its job history will be permanently removed and cannot be recovered.

Delete session

Converses with your data. Ask any question you have about your data and get insights instantly. 
On Powerdrill, a **job** refers to a task that Powerdrill performs to generate a response based on your request (e.g., a prompt or other workflows). Powerdrill Enterprise supports two types of jobs: **general jobs** and **data agent jobs**. Currently, only general jobs are available, so make sure the **x-pd-api-agent-id** header is set to **GENERAL**.  
- For an in-depth explanation of **jobs**, see [What Is Job?](/enterprise/what-is-job).  
- To quickly create and execute a job, see [Quick Start](/api-reference/quick-start-for-general). 

Create job

Creates a data agent.
The data agent will not be active immediately. To activate it, send a **POST** request to the `/v1/subscriptions` API URL, subscribing to a plan of type `AGENT_MODE_PLAN` and setting the `targetId` to the data agent ID.

Create agent

Obtains information about the specified data agent.

Get agent

Deletes the specified data agent. Once deleted, the data agent cannot be recovered.

Delete agent

List agents

Create subscription

Renews the specified subscription. You can only renew subscriptions that you've previously canceled and that are still within the active subscription period.

API Reference Overview

Datasets

Data sources

Files

Sessions

Jobs

Agents

Subscriptions

Projects

Team

Get subscription

Authorizations

Headers

Path Parameters

Response