GET
/
v1
/
predictions
/
batch
/
{batch_id}
JavaScript
import Semilattice from 'semilattice';

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

const predictionBatch = await client.predictions.getBatch('batch_id');

console.log(predictionBatch.data);
{
  "data": {
    "batch": {
      "id": "<string>",
      "batch_type": "prediction",
      "population": "<string>",
      "created_at": "2025-06-23T15:38:01Z",
      "data_source": "User onboarding flow",
      "description": "A copy testing benchmarking batch",
      "effective_date": "2024-01-09",
      "name": "Q4 user trends questions",
      "public": true,
      "simulation_engine": "answers-1",
      "status": "Tested",
      "prediction_started_at": "2025-06-23T15:41:02Z",
      "prediction_finished_at": "2025-06-23T15:43:56Z"
    },
    "predictions": [
      {
        "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

Path Parameters

batch_id
string
required

ID of the prediction batch you want to fetch.

Response

Successful Response

data
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.