Skip to content

A question answer

GET
/v1/questions/{id}/answer
curl --request GET \
--url https://beta-api.plune.ai/v1/questions/example/answer \
--header 'Authorization: Bearer <token>'

«n of N» with at most 20 rows and the link to the cases under the same filter (AC-03, AC-04). A question a health widget answers is that card own answer. Read inside 5 s, a widget block cut: past it n and N are null and notMeasured says block_timeout. Reads only.

id
required
string

The answer

Media type application/json
object
questionId
required
string
denominator
required

N = 0 is «no data»; n = 0 with N > 0 the good state; both null when the question ran out of its 5 s (block_timeout).

object
n
required
integer
nullable
N
required
integer
nullable
unit
required
string
Allowed values: cases runs
items
required

The first rows: a case id and title, or the health card own rows.

Array<object>
<= 20 items
object
truncated
required
boolean
href
required

A path in the project: the case list under the same filter inside its base (the set counted), the health card, or the run whose cost it is; null when no case matched (no card leads to an empty list), with no finished run, or for a cost not measured in time.

string
nullable
notMeasured
required
Array<object>
object
code
required
string
params
object
extra

The cost of the last finished run: runId, runNumber (its place among the project runs by start, 1 the first, runs in the Bin counted), title, startedAt, results (how many results it holds), usd, unknownTokens.

object
Example
{
"questionId": "6f1c2b3a-0000-4000-8000-000000001292",
"denominator": {
"n": 1,
"N": 4,
"unit": "cases"
},
"items": [
{
"caseId": "6f1c2b3a-0000-4000-8000-0000000000c1",
"title": "Checkout with an empty cart"
}
],
"truncated": false,
"href": "/cases?tag=smoke&state=draft",
"notMeasured": []
}

No / invalid token or session

No such question in the project

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

The stored filter no longer matches the case filter

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