Get a single run + its first 500 per-lead generations

GET /api/v1/personalize/generations/runs/{run_id}

Get a single run + its first 500 per-lead generations

cURL

curl --request GET \
  --url https://api.example.com/api/v1/personalize/generations/runs/{run_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "run": {
    "run_id": "<string>",
    "prompt_source": "named",
    "n_leads": 123,
    "n_completed": 123,
    "n_failed": 123,
    "status": "in_progress",
    "started_at": "<string>",
    "prompt_name": "<string>",
    "completed_at": "<string>",
    "model_version": "<string>",
    "error": "<string>",
    "metadata": {}
  },
  "generations": [
    {
      "generation_id": "<string>",
      "lead_index": 123,
      "lead_snapshot": {},
      "status": "generated",
      "generated_at": "<string>",
      "subject": "<string>",
      "body": "<string>",
      "error": "<string>"
    }
  ],
  "total_generations": 123,
  "has_more": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

run_id · string · required

Response

200

application/json

Successful Response

run · RunDetail · object · required

Show child attributes

generations · GenerationRow · object[] · required

Show child attributes

total_generations · integer · required

has_more · boolean · required