POST
/
v2
/
team
/
sessions
/
{id}

Authorizations

x-pd-api-key
string
header
required

Headers

x-pd-external-trace-id
string

The trace ID you set in your system to trace this request. It can be up to 128 characters in length. If the request fails, you can provide it to the Powerdrill team to help with troubleshooting.

Path Parameters

id
string
required

The ID of the session you want to modify.

To check sessions existing in your project, call GET /v2/team/sessions.

Body

application/json
name
string
required

The session name, which can be up to 128 characters in length. If it exceeds this limit, it will be truncated.

user_id
string
required

Your user ID, which uniquely identifies you within your team. To obtain your ID:

output_language
enum<string>
default:
AUTO

The language in which the output is generated. For example, if set to EN, the output will be in English. If not specified, the default setting AUTO will be used, which allows Powerdrill Enterprise to automatically detect the appropriate language for the output based on your question. Possible values are:

  • AUTO: adaptive recognition
  • EN: English
  • ES: Spanish
  • AR: Arabic
  • PT: Portuguese
  • ID: Indonesian
  • JA: Japanese
  • RU: Russian
  • HI: Hindi
  • FR: French
  • DE: German
  • VI: Vietnamese
  • TR: Turkish
  • PL: Polish
  • IT: Italian
  • KO: Korean
  • ZH-CN: Simplified Chinese
  • ZH-TW: Traditional Chinese
Available options:
AUTO,
EN,
ES,
AR,
PT,
ID,
JA,
RU,
HI,
FR,
DE,
VI,
TR,
PL,
IT,
KO,
ZH-CN,
ZH-TW
job_mode
enum<string>
default:
DATA_ANALYTICS

Job mode. Possible values are:

  • AUTO: Powerdrill automatically detects your intent and selects the appropriate job mode from data analysis and information retrieval.
  • DATA_ANALYTICS: Powerdrill focuses specifically on data analysis.

If not specified, the default setting AUTO will be used. However, if your intent is clearly data analysis, we recommend specifying the value as DATA_ANALYSIS. This helps Powerdrill skip the intention detection step, enabling faster question processing.

Available options:
AUTO,
DATA_ANALYTICS
max_contextual_job_history
integer

The maximum number of recent jobs retained as context for the next job, with a value range of 0 to 10. The default value is 10. If set to 0, jobs will be run without any context from previous jobs.

Response

200 - application/json
code
integer
required

Status code. 0 indicates that the operation is successful. Otherwise, the operation fails. For error troubleshooting, refer to Error Codes.

data
object
required

Null is returned when the operation is successful.