Skip to content

Save a question

POST
/v1/questions
curl --request POST \
--url https://beta-api.plune.ai/v1/questions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "title": "Smoke cases still in draft", "filter": "state=draft&tag=smoke" }'

A question from a case filter (AC-05; «Save as question»). The filter is judged against the case filter vocabulary and stored canonical; a key it does not know is a 400. A base that names a key of the filter with other values is a 400: the link opens the filter inside its base. With a source, the filter may name the suite, the tags and the flags only. At most 100 active questions a project (409 question_limit). Owner or member; a reader gets 403.

Media type application/json
object
title
required
string
>= 1 characters <= 120 characters
filter
required
string
<= 2000 characters
base
string
<= 2000 characters
source
string
Allowed values: never_run ever_failing flaky slowest last_run_cost
Example
{
"title": "Smoke cases still in draft",
"filter": "state=draft&tag=smoke"
}

Saved

Media type application/json
object
id
required
string
projectId
required
string
title
required
string
>= 1 characters <= 120 characters
config
required

A question (#1292): a canonical case-filter query string - the one of GET /v1/test-cases and of a plan - and, for the questions a health widget answers, its name.

object
schemaVersion
required
integer
Allowed values: 1
kind
required
string
Allowed values: question
filter
required

The cases the question asks about: n, and the link.

string
<= 2000 characters
base

The cases N counts; absent, every live case of the project.

string
<= 2000 characters
source

The handler that answers it, as the Analytics card does.

string
Allowed values: never_run ever_failing flaky slowest last_run_cost
starterKey

A starter question key; the page words its title in the reader language by it.

string
position
required
integer
createdBy
required

null for a starter question: nobody made it.

string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"id": "6f1c2b3a-0000-4000-8000-000000001292",
"projectId": "u-shop::default",
"title": "Smoke cases still in draft",
"config": {
"schemaVersion": 1,
"kind": "question",
"filter": "tag=smoke&state=draft"
},
"position": 12,
"createdBy": "u-shop",
"createdAt": "2026-09-16T09:12:04.151Z",
"updatedAt": "2026-09-16T09:12:04.151Z"
}

Invalid body or filter

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

No / invalid token or session

A read-only member

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

The project already has 100 active questions

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}

Rate-limited: the per-route throttle, or the per-minute request limit of the plan an API token counts by (#1442; the body names the plan, #2092). Retry-After carries the seconds until the window rolls over.

Media type application/json
object
error
required
string
Example generated
{
"error": "example"
}
Retry-After
integer

Seconds until the window rolls over