Skip to main content
POST
Create an exploratory session

Authorizations

Authorization
string
header
required

User PAT (td_pat_) scoped to the target project

Headers

Idempotency-Key
string

Optional but recommended on create (POST) requests. Send a unique value (e.g. a UUID) per logical create. A retry with the same key within 24h replays the original response instead of creating a duplicate. Same key with a different body returns 422 IDEMPOTENCY_KEY_REUSE; a key for a request still in flight returns 409. Omitting the header is allowed (no deduplication).

Path Parameters

projectId
string
required

The project identifier (e.g. project_abc123). Must match the project associated with your PAT.

Body

application/json
name
string
required
Maximum string length: 255
mission
string

Rich HTML charter.

sessionType
string
config
string
environment
string
releaseId
string
assigneeUserId
string

User _id or email.

state
string

Project-configured workflow state.

estimate
integer

Estimate in minutes.

Required range: x >= 0
tags
string[]

JSON array of strings.

linkedIssues
object[]

Response

Session created

success
enum<boolean>
Available options:
true
data
object
pagination
object