Follow this guide to learn how to create a dataset, add data sources to the dataset, create a session associated with the dataset, and then run jobs to start anayzing the uploaded data.

​
Step 1. Get your project API key

If you’re the admin of your team, get API key of the target project on the admin console.

If you’re a system user or virtual user in a team, simply ask your admin to provide you with one.

​
Step 2. Create a dataset and upload a data source to it

This step is optional but highly recommended, as it allows you to receive insights tailored to your own data.

Data sources are the data you upload to Powerdrill for embedding, indexing, knowledge extraction, and vectorized storage and retrieval, while datasets are collections of data sources that help organize and categorize them.

You can create datasets and data sources in two ways:

  • Method 1: Create a dataset first, then add data sources to it.

  • Method 2: Create a data source directly without specifying a dataset, and Powerdrill will automatically create a dataset for it.

  1. Make a request to POST /v1/team/datasets endpoint to create a dataset.

    Example request:

    curl --request POST \
  --url https://ai.data.cloud/api/v1/team/datasets \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: $PD_API_KEY' \
  --data '{
  "name": "My dataset",
  "description": "my default dataset",
  "userId": "tmm-cm5m7khoz52zh07n4m7x1ut60"
}'

    Replace $PD_API_KEY with the API key you’ve obtained in Step 1.

    Example response:

    {
    "code": 0,
    "data": {
        "id": "cm3my37en3q36017q7x3hyyf4"
    }
}

    Obtain the id value (dataset ID) from the response and save it for later use.

  2. Make a request to the POST /v1/team/datasets/{datasetId}/datasources endpoint. Replace the datasetId value with the ID of the dataset you’ve created in the previous sub-step

When making the request, specify either url or fileKey, but not both. Use url to upload a file through a publicly accessible URL. For privately accessible files, use fileKey.

Example request:

curl --request POST \
  --url https://ai.data.cloud/api/v1/team/datasets/{datasetId}/datasources \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: $PD_API_KEY' \
  --data '{
  "name": "test.csv",
  "fileName": "test.csv",
  "type": "FILE",
  "url": "https://s3.amazonaws.com/powerdrilltest/user/clvl4cad2001q01l1m522hxlu/upload/f9773f1e-cd68-489a-8121-d566ca9218b1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240924T143419Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=AKIARLSQLXURHEIDN4OZ%2F20240924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ca0c58d508926a5811818041d557ffb53c64025dae94c0855280d457c7089a2",
  "userId": "tmm-cm5m7khoz52zh07n4m7x1ut60"
}'

Example response:

{
    "code": 0,
    "data": {
        "id": "cm3myfsfc03jn011csb8wah6p",
        "datasetId": "cm3my37en3q36017q7x3hyyf4",
        "name": "test.pdf",
        "fileName": "test.pdf",
        "type": "FILE",
        "status": "pending"
    }
}

Repeat this sub-step to create multiple data sources in the same dataset.

​
Step 3. Create a session

To create a session, make a request to the POST /v1/team/sessions endpoint. Sessions are essential for running jobs on Powerdrill, as each job must be linked to a session using its session ID.

Example request:

curl --request POST \
  --url https://ai.data.cloud/api/v1/team/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: $PD_API_KEY' \
  --data '{
  "title": "My session",
  "languageType": "AUTO",
  "jobMode": "AUTO",
  "maxMessagesInContext": 10,
  "userId": "tmm-egejgowqg=g=egen"
}'

When making a request:

  • Replace $PD_API_KEY with the API key you’ve obtained in Step 1.

  • Set the user ID to your actual user ID.

Example response:

{
    "code": 0,
    "data": {
        "id": "4440ab38-3df0-465b-a66c-bf6acb0f1bc2"
    }
}

Obtain the id value (session ID) from the response and save it for use in the following step.

​
Step 4. Create a job

Now, after you’ve prepared a session and probably a dataset stuffed with data sources, you can create a job to start conversing with Powerdrill.

For the definition of job, see What Is Job?.

Make a request to the POST /v1/team/jobs endpoint.

Powerdrill provides the ability to stream responses, controlled by the stream parameter. For more details about how to understand the streaming mode, see Streaming.

  • If stream is set to true, streaming is enabled.

  • If stream is set to false, streaming is disabled.

Example request:

curl --request POST \
  --url https://ai.data.cloud/api/v1/team/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: $PD_API_KEY' \
  --data '{
"datasetId": "cm1gjmg8e0057r3x22v1fdu8m",
"datasourceIdList": [
  "cm1gjmmoo0001h0x24uk1xgu9"
],
"languageType": "EN",
"question": "Hello World",
"sessionId": "5534f591-1520-4e74-b753-b87615b2c57a",
"stream": false
}'

When making a request:

  • Replace $PD_API_KEY with the API key you’ve obtained in Step 1.

  • Since this topic covers running a general job and no data agent is used, set the x-pd-api-agent-id header to GENERAL (uppercase).

  • Replace the sessionId value with the ID of the session you’ve created in Step 3.

  • To enable Powerdrill to retrieve information from your own data and provide responses specific to it, set the datasetId to the ID of the dataset obtained in Step 2.

Follow this guide to learn how to create a dataset, add data sources to the dataset, create a session associated with the dataset, and then run jobs to start anayzing the uploaded data.

​
Step 1. Get your project API key

If you’re the admin of your team, get API key of the target project on the admin console.

If you’re a system user or virtual user in a team, simply ask your admin to provide you with one.

​
Step 2. Create a dataset and upload a data source to it

This step is optional but highly recommended, as it allows you to receive insights tailored to your own data.

Data sources are the data you upload to Powerdrill for embedding, indexing, knowledge extraction, and vectorized storage and retrieval, while datasets are collections of data sources that help organize and categorize them.

You can create datasets and data sources in two ways:

  • Method 1: Create a dataset first, then add data sources to it.

  • Method 2: Create a data source directly without specifying a dataset, and Powerdrill will automatically create a dataset for it.

  1. Make a request to POST /v1/team/datasets endpoint to create a dataset.

    Example request:

    curl --request POST \
  --url https://ai.data.cloud/api/v1/team/datasets \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: $PD_API_KEY' \
  --data '{
  "name": "My dataset",
  "description": "my default dataset",
  "userId": "tmm-cm5m7khoz52zh07n4m7x1ut60"
}'

    Replace $PD_API_KEY with the API key you’ve obtained in Step 1.

    Example response:

    {
    "code": 0,
    "data": {
        "id": "cm3my37en3q36017q7x3hyyf4"
    }
}

    Obtain the id value (dataset ID) from the response and save it for later use.

  2. Make a request to the POST /v1/team/datasets/{datasetId}/datasources endpoint. Replace the datasetId value with the ID of the dataset you’ve created in the previous sub-step

When making the request, specify either url or fileKey, but not both. Use url to upload a file through a publicly accessible URL. For privately accessible files, use fileKey.

Example request:

curl --request POST \
  --url https://ai.data.cloud/api/v1/team/datasets/{datasetId}/datasources \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: $PD_API_KEY' \
  --data '{
  "name": "test.csv",
  "fileName": "test.csv",
  "type": "FILE",
  "url": "https://s3.amazonaws.com/powerdrilltest/user/clvl4cad2001q01l1m522hxlu/upload/f9773f1e-cd68-489a-8121-d566ca9218b1.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20240924T143419Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=AKIARLSQLXURHEIDN4OZ%2F20240924%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9ca0c58d508926a5811818041d557ffb53c64025dae94c0855280d457c7089a2",
  "userId": "tmm-cm5m7khoz52zh07n4m7x1ut60"
}'

Example response:

{
    "code": 0,
    "data": {
        "id": "cm3myfsfc03jn011csb8wah6p",
        "datasetId": "cm3my37en3q36017q7x3hyyf4",
        "name": "test.pdf",
        "fileName": "test.pdf",
        "type": "FILE",
        "status": "pending"
    }
}

Repeat this sub-step to create multiple data sources in the same dataset.

​
Step 3. Create a session

To create a session, make a request to the POST /v1/team/sessions endpoint. Sessions are essential for running jobs on Powerdrill, as each job must be linked to a session using its session ID.

Example request:

curl --request POST \
  --url https://ai.data.cloud/api/v1/team/sessions \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: $PD_API_KEY' \
  --data '{
  "title": "My session",
  "languageType": "AUTO",
  "jobMode": "AUTO",
  "maxMessagesInContext": 10,
  "userId": "tmm-egejgowqg=g=egen"
}'

When making a request:

  • Replace $PD_API_KEY with the API key you’ve obtained in Step 1.

  • Set the user ID to your actual user ID.

Example response:

{
    "code": 0,
    "data": {
        "id": "4440ab38-3df0-465b-a66c-bf6acb0f1bc2"
    }
}

Obtain the id value (session ID) from the response and save it for use in the following step.

​
Step 4. Create a job

Now, after you’ve prepared a session and probably a dataset stuffed with data sources, you can create a job to start conversing with Powerdrill.

For the definition of job, see What Is Job?.

Make a request to the POST /v1/team/jobs endpoint.

Powerdrill provides the ability to stream responses, controlled by the stream parameter. For more details about how to understand the streaming mode, see Streaming.

  • If stream is set to true, streaming is enabled.

  • If stream is set to false, streaming is disabled.

Example request:

curl --request POST \
  --url https://ai.data.cloud/api/v1/team/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-pd-api-key: $PD_API_KEY' \
  --data '{
"datasetId": "cm1gjmg8e0057r3x22v1fdu8m",
"datasourceIdList": [
  "cm1gjmmoo0001h0x24uk1xgu9"
],
"languageType": "EN",
"question": "Hello World",
"sessionId": "5534f591-1520-4e74-b753-b87615b2c57a",
"stream": false
}'

When making a request:

  • Replace $PD_API_KEY with the API key you’ve obtained in Step 1.

  • Since this topic covers running a general job and no data agent is used, set the x-pd-api-agent-id header to GENERAL (uppercase).

  • Replace the sessionId value with the ID of the session you’ve created in Step 3.

  • To enable Powerdrill to retrieve information from your own data and provide responses specific to it, set the datasetId to the ID of the dataset obtained in Step 2.