Assessments
List Candidate Keys
List all candidate keys for an assessment.
GET
/
v1
/
assessments
/
:id
/
keys
curl https://api.promptster.ai/v1/assessments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/keys \
-H "Authorization: Bearer psk_live_abc123def456"
{
"keys": [
{
"id": "k1a2b3c4-d5e6-7890-abcd-ef1234567890",
"key": "PST-ABCD-1234",
"assessmentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"orgId": "org_2abc123",
"candidateEmail": "[email protected]",
"candidateName": "Jane Smith",
"status": "completed",
"sessionId": "sess_abc123",
"expiresAt": "2026-04-14T10:30:00.000Z",
"redeemedAt": "2026-04-08T09:00:00.000Z",
"completedAt": "2026-04-08T10:15:00.000Z",
"totalCostUsd": 3.42,
"createdAt": "2026-04-07T10:30:00.000Z"
}
]
}
Returns all active (non-deleted) candidate keys for the specified assessment, ordered by creation date. Includes the total token cost for each candidate’s session.
Authentication
Requires an org API key.Authorization: Bearer psk_live_...
string
required
The assessment ID (UUID).
array
List of candidate key objects with usage cost.
Show properties
Show properties
string
Key record ID (UUID).
string
The candidate key (e.g.
PST-ABCD-1234).string | null
Candidate’s email.
string | null
Candidate’s name.
string
pending, active, completed, or expired.string | null
Linked session ID once the candidate starts.
string
ISO 8601 expiration timestamp.
string | null
When the candidate redeemed the key.
string | null
When the candidate submitted.
number
Total LLM token cost in USD for this candidate’s session.
{
"keys": [
{
"id": "k1a2b3c4-d5e6-7890-abcd-ef1234567890",
"key": "PST-ABCD-1234",
"assessmentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"orgId": "org_2abc123",
"candidateEmail": "[email protected]",
"candidateName": "Jane Smith",
"status": "completed",
"sessionId": "sess_abc123",
"expiresAt": "2026-04-14T10:30:00.000Z",
"redeemedAt": "2026-04-08T09:00:00.000Z",
"completedAt": "2026-04-08T10:15:00.000Z",
"totalCostUsd": 3.42,
"createdAt": "2026-04-07T10:30:00.000Z"
}
]
}
curl https://api.promptster.ai/v1/assessments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/keys \
-H "Authorization: Bearer psk_live_abc123def456"
curl https://api.promptster.ai/v1/assessments/a1b2c3d4-e5f6-7890-abcd-ef1234567890/keys \
-H "Authorization: Bearer psk_live_abc123def456"
{
"keys": [
{
"id": "k1a2b3c4-d5e6-7890-abcd-ef1234567890",
"key": "PST-ABCD-1234",
"assessmentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"orgId": "org_2abc123",
"candidateEmail": "[email protected]",
"candidateName": "Jane Smith",
"status": "completed",
"sessionId": "sess_abc123",
"expiresAt": "2026-04-14T10:30:00.000Z",
"redeemedAt": "2026-04-08T09:00:00.000Z",
"completedAt": "2026-04-08T10:15:00.000Z",
"totalCostUsd": 3.42,
"createdAt": "2026-04-07T10:30:00.000Z"
}
]
}