Skip to the page

Praecise Platform

Rivier/ Reference/ analytics

Try a decision in simulation before making it

post/whatif

Try a decision in simulation before making it: a question and two or three options, run on the same seeds.

Before you call

Credential: Authorization: Bearer $KEY
Scope: analytics:write
Graphql: Mutation.analyticsWhatifStart
Sdk: analytics.whatif.start
Cli: analytics whatif start

Request bodyapplication/json, required

questionstringrequired
At most 300 characters.
optionslist of objectrequired
- labelstringrequired
  At most 40 characters.
- textstringrequired
  At most 1500 characters.
seedinteger

Responses

202application/json
Success
object
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/whatif' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "question": "string",
  "options": [
    {
      "label": "string",
      "text": "string"
    }
  ]
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown