Get Test

Retrieve the status and details of a test generation request.

GET /v1/platform/tests/:id

Returns the current status and details of a test generation request. Use this endpoint to poll for completion when using async mode.

Path Parameters

ParameterTypeDescription
idstringThe test request ID returned by the create endpoint

Example Request

curl https://api.tutorflow.io/v1/platform/tests/a1c2d3e4-f5g6-7h8i-9j0k-l1m2n3o4p5q6 \
  -H "Authorization: Bearer tf_platform_..."

Response

Returns the same TestResDto structure as the create endpoint. See Create Test for the full list of response fields.

When the test generation is still in progress, isTerminal will be false and pollAfterMs will indicate how long to wait before polling again.

Example Response (Completed)

{
  "id": "a1c2d3e4-f5g6-7h8i-9j0k-l1m2n3o4p5q6",
  "status": "COMPLETED",
  "classroomTestId": "c7d8e9f0-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
  "title": "Basic Algebra Quiz",
  "description": "A 10-question quiz covering linear equations and inequalities.",
  "level": "medium",
  "timeLimit": 30,
  "totalScore": 100,
  "itemCount": 10,
  "tier": "standard",
  "priceSnapshot": {
    "category": "test_creation",
    "catalogKey": "test_creation.standard",
    "tier": "standard",
    "amountUsd": 0.15,
    "unit": "test",
    "currency": "USD",
    "source": "platform_pricing_catalog_v1"
  },
  "shareToken": "b018172542f9a3c4d5e6f7890abcdef12345678",
  "previewUrl": "https://tutorflow.io/en/platform/tests/b018172542f9a3c4d5e6f7890abcdef12345678",
  "publicUrl": "https://tutorflow.io/en/platform/tests/take/b018172542f9a3c4d5e6f7890abcdef12345678",
  "idempotencyKey": null,
  "idempotentReplay": null,
  "isTerminal": true,
  "createdAt": "2026-03-24T12:00:00.000Z",
  "completedAt": "2026-03-24T12:00:16.000Z"
}

Example Response (Pending)

While a request is pending, only the request-side fields are populated. Result-side fields (classroomTestId, totalScore, itemCount, shareToken, previewUrl, publicUrl, completedAt) are omitted until generation completes.

{
  "id": "a1c2d3e4-f5g6-7h8i-9j0k-l1m2n3o4p5q6",
  "status": "PROCESSING",
  "classroomTestId": null,
  "title": null,
  "description": null,
  "level": null,
  "timeLimit": 30,
  "tier": "standard",
  "priceSnapshot": {
    "category": "test_creation",
    "catalogKey": "test_creation.standard",
    "tier": "standard",
    "amountUsd": 0.15,
    "unit": "test",
    "currency": "USD",
    "source": "platform_pricing_catalog_v1"
  },
  "idempotencyKey": null,
  "idempotentReplay": null,
  "isTerminal": false,
  "pollAfterMs": 3000,
  "createdAt": "2026-03-24T12:00:00.000Z"
}