Skip to main content
POST
/
v1
/
predictions
JavaScript
import Semilattice from 'semilattice';

const client = new Semilattice({
  apiKey: 'My API Key',
});

const apiResponseListPredictions = await client.predictions.create({
  population_id: 'population_id',
  predictions: { question: 'question', question_options: { question_type: 'single-choice' } },
});

console.log(apiResponseListPredictions.data);
{
  "data": [
    {
      "id": "b8b3e8cb-4c67-40d7-8350-3eac3c2b127d",
      "batch": "1e6bfe22-40d9-46c4-b241-9e1d7d5c5560",
      "created_at": "2025-06-23T15:40:52Z",
      "prediction_started_at": "2025-06-23T15:41:02Z",
      "prediction_finished_at": "2025-06-23T15:43:56Z",
      "population": "af8917b4-a09c-41f9-9c9f-c4c40c1f7415",
      "simulation_engine": "answers-1",
      "status": "Predicted",
      "public": false,
      "answer_options": [
        "Tech debt",
        "Unclear error messages"
      ],
      "population_name": "Developers",
      "question": "Tech debt or unclear error messages, what's worse?",
      "question_options": {
        "question_type": "single-choice"
      },
      "simulated_answer_percentages": {
        "Tech debt": 0.5488,
        "Unclear error messages": 0.4512
      },
      "predicted_answer_percentages": {
        "Tech debt": 0.5488,
        "Unclear error messages": 0.4512
      }
    }
  ],
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Headers

authorization
string

Body

application/json

Parameters for one or more predictions you'd like to run. Accepts either a single object or a list.

population_id
string
required

ID of the population model against which to run the simulation

predictions
required

One or more predictions to run.

batch
object | null

Optional batch details to apply to these predictions. If provided, a batch object will be created.

Response

Successful Response

data
PredictionsResponse · object[] | null

The primary response payload. Contains the result of the request if successful.

errors
ErrorResponse · object[] | null

List of structured error messages, if any occurred during the request.