{ "item": [ { "name": "scenarios", "description": "", "item": [ { "id": "69a28270-7885-41eb-8506-a627d7407793", "name": "List scenarios", "request": { "name": "List scenarios", "description": { "content": "Lists the organization's role-play scenarios, most relevant first.", "type": "text/plain" }, "url": { "path": [ "scenarios" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "c94154d3-6d16-42a3-8c54-ffe90a00a290", "name": "Organization scenarios.", "originalRequest": { "url": { "path": [ "scenarios" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scenarios\": [\n {\n \"slug\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"visibility\": \"private\",\n \"domainSlug\": \"\",\n \"order\": \"\",\n \"assignmentCount\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n },\n {\n \"slug\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"visibility\": \"public\",\n \"domainSlug\": \"\",\n \"order\": \"\",\n \"assignmentCount\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\"\n }\n ],\n \"pagination\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67d258ae-00a0-4525-9b6f-960beb82ad5b", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "scenarios" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4340f111-0805-4d5e-810a-953624f5d8f6", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "scenarios" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{scenarioSlug}", "description": "", "item": [ { "id": "4ca83049-2f92-4b76-b860-b3a0c40900c4", "name": "Get a scenario", "request": { "name": "Get a scenario", "description": { "content": "Returns one scenario including its role-play configuration (`data`). The data payload is dashboard-controlled and may gain fields at any time.", "type": "text/plain" }, "url": { "path": [ "scenarios", ":scenarioSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "react-mock-interview", "key": "scenarioSlug", "disabled": false, "description": { "content": "(Required) Scenario slug.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "086027ea-8e0b-4401-aa8a-8ac924e2d66a", "name": "Scenario details.", "originalRequest": { "url": { "path": [ "scenarios", ":scenarioSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Scenario slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "scenarioSlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"scenario\": {\n \"slug\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"visibility\": \"public\",\n \"domainSlug\": \"\",\n \"order\": \"\",\n \"assignmentCount\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"data\": {\n \"key_0\": false\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbafcb82-0d39-449f-8036-6b000f1b80f3", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "scenarios", ":scenarioSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Scenario slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "scenarioSlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a16889e7-41ec-4422-84d1-3af0c9d049d2", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "scenarios", ":scenarioSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Scenario slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "scenarioSlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f494e61e-3eae-432b-ab03-17892c707de8", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "scenarios", ":scenarioSlug" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Scenario slug.", "type": "text/plain" }, "type": "any", "value": "", "key": "scenarioSlug" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "users", "description": "", "item": [ { "id": "5f13416e-96d1-4383-8560-7137843890c8", "name": "List learners", "request": { "name": "List learners", "description": { "content": "Lists learners and pending invitations in the API key's organization.", "type": "text/plain" }, "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a7807c21-eeeb-473f-8387-b2f27f6cb786", "name": "Learners and pending invitations.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"users\": [\n {\n \"id\": \"\",\n \"memberId\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"emailVerified\": \"\",\n \"role\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"id\": \"\",\n \"memberId\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"emailVerified\": \"\",\n \"role\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"invitations\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"createdAt\": \"\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"createdAt\": \"\"\n }\n ],\n \"pagination\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78ec9642-1b9c-4336-9ef9-c09f8697eb6c", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcbfd90b-b93b-408a-86bf-50d50259812c", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f113a9f-cb76-4319-a094-886b19bc952e", "name": "Invite a learner", "request": { "name": "Invite a learner", "description": { "content": "Creates or refreshes a pending learner invitation. Email failure does not roll back the invitation.", "type": "text/plain" }, "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "e0261a39-dcb9-4d1d-8e91-c6e015e5f0ac", "name": "Existing pending invitation refreshed.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"invitation\": {\n \"id\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"createdAt\": \"\"\n },\n \"emailSent\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6ec8ecba-c4e4-474b-b35a-daece528a9e7", "name": "Invitation created.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"invitation\": {\n \"id\": \"\",\n \"email\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"createdAt\": \"\"\n },\n \"emailSent\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bf15715-9942-4e00-8be1-6cf0dc6c4871", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a148c45-39cb-481b-bc6d-fd106b96a269", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc8b09fb-4fea-4afc-9e4c-7d109c8f95bd", "name": "API key creator is no longer an organization trainer.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c2d58ee4-0c6c-490a-8ae0-2d3017a48f1d", "name": "Request conflicts with existing organization data.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c8fbc927-8978-4382-b63d-cb296681be7d", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "users" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{userId}", "description": "", "item": [ { "id": "d302bd99-f563-4b2d-a733-43236712c987", "name": "Get a learner", "request": { "name": "Get a learner", "description": {}, "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "your_learner_id", "key": "userId", "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5570b69c-ebcb-4429-aed2-e06fb0cb37a0", "name": "Learner details.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user\": {\n \"id\": \"\",\n \"memberId\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"emailVerified\": \"\",\n \"role\": \"\",\n \"createdAt\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ac414b4-72a5-41c1-839d-7fff7e655fac", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4191c1bc-1c74-4203-bd1e-491355beab9e", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7612bbf4-06c6-41a6-96a7-a685cce3a9d3", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e648fbe2-9d16-4613-8653-c76779473f45", "name": "Update a learner", "request": { "name": "Update a learner", "description": { "content": "Updates the learner's display name. Email and role changes are not supported.", "type": "text/plain" }, "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "your_learner_id", "key": "userId", "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "1f2c1c39-bc35-4b9f-823a-d70cac9aa938", "name": "Updated learner.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"user\": {\n \"id\": \"\",\n \"memberId\": \"\",\n \"name\": \"\",\n \"email\": \"\",\n \"emailVerified\": \"\",\n \"role\": \"\",\n \"createdAt\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c9ff2f6-b184-4ae2-b91f-3d4b5bd642a9", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1d6d218-e5a2-4477-a57c-df651c269c13", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8690cd46-4823-4bf6-84a7-99fd8372c69f", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89c32958-4ff6-41ce-b8e2-e60ba55da525", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d798936e-50f9-4fb5-9f1c-8a5706a99122", "name": "Remove a learner", "request": { "name": "Remove a learner", "description": { "content": "Removes the learner's organization membership and assignments without deleting their account or historical sessions.", "type": "text/plain" }, "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "your_learner_id", "key": "userId", "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "25135c19-1dcd-4f66-ac51-2127e9401b72", "name": "Learner removed.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "5b5506d6-65e5-42f4-9013-7bc0e762e14c", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64a09ef9-13d7-43c6-8b5e-27d131d456ac", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f549fe94-e13c-401d-8f9b-3aa9fc7fef31", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "users", ":userId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Learner user ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "userId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "assignments", "description": "", "item": [ { "id": "b81169dd-50e7-47a7-9740-3c5a4fa22ef8", "name": "List assignments", "request": { "name": "List assignments", "description": {}, "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by learner user ID.", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "Filter by published scenario slug.", "type": "text/plain" }, "key": "scenario", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d87eb8f0-8b90-4f4d-bec1-1c829f331a08", "name": "Organization assignments.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by learner user ID.", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "Filter by published scenario slug.", "type": "text/plain" }, "key": "scenario", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assignments\": [\n {\n \"id\": \"\",\n \"assignedAt\": \"\",\n \"status\": \"expired\",\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"scenario\": {\n \"slug\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"visibility\": \"public\"\n },\n \"practiceUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"assignedAt\": \"\",\n \"status\": \"used\",\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"scenario\": {\n \"slug\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"visibility\": \"public\"\n },\n \"practiceUrl\": \"\"\n }\n ],\n \"pagination\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b7c1522e-7884-4a2f-a7b5-477c621a8115", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by learner user ID.", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "Filter by published scenario slug.", "type": "text/plain" }, "key": "scenario", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12c2ab44-7623-4b32-8b79-6bf7b5e417a0", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by learner user ID.", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "Filter by published scenario slug.", "type": "text/plain" }, "key": "scenario", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d6f38f2-c02a-48fd-9d24-5c2e919ff844", "name": "Create an assignment", "request": { "name": "Create an assignment", "description": { "content": "Idempotently assigns a published scenario to a learner. Email failure does not roll back the assignment.", "type": "text/plain" }, "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"jp\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "760e6547-13e8-44e5-82ac-14caf395909c", "name": "Assignment already existed.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"jp\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assignment\": {\n \"id\": \"\",\n \"assignedAt\": \"\",\n \"userId\": \"\",\n \"scenario\": \"\"\n },\n \"created\": \"\",\n \"emailSent\": \"\",\n \"practiceUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4a78280-b49a-4ed0-8e27-1e0034325010", "name": "Assignment created.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"jp\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assignment\": {\n \"id\": \"\",\n \"assignedAt\": \"\",\n \"userId\": \"\",\n \"scenario\": \"\"\n },\n \"created\": \"\",\n \"emailSent\": \"\",\n \"practiceUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0bbc7d8-2fd7-4fa0-821d-0f2939fbda28", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"jp\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26fdbd5b-a2fa-4078-99c3-6fe900fe8c74", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"jp\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b5e1481e-b14a-4e18-8ac5-de077736b0d6", "name": "API key creator is no longer an organization trainer.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"jp\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b01619dc-487c-4f2b-974d-088a0f3cda73", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"jp\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "af3fc6c4-9c3b-4850-8a2f-37a80c240d4b", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "assignments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"jp\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{assignmentId}", "description": "", "item": [ { "id": "3021b408-99e7-41dc-bb51-018067c408ac", "name": "Get an assignment", "request": { "name": "Get an assignment", "description": {}, "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "your_assignment_id", "key": "assignmentId", "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d5b3729f-fa0a-41fa-80b6-40d0e251dff0", "name": "Assignment details.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assignment\": {\n \"id\": \"\",\n \"assignedAt\": \"\",\n \"status\": \"used\",\n \"user\": {\n \"id\": \"\",\n \"name\": \"\",\n \"email\": \"\"\n },\n \"scenario\": {\n \"slug\": \"\",\n \"name\": \"\",\n \"version\": \"\",\n \"visibility\": \"private\"\n },\n \"practiceUrl\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "641df30b-7cf9-4421-bc52-aeb4fb5277e1", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "593d8e11-5feb-4007-8740-0d0579998718", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "62906768-a1ab-4be6-99b9-9d8798f20bbe", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9b5d416c-cbba-41a6-b1b5-d67656f94909", "name": "Update an assignment", "request": { "name": "Update an assignment", "description": { "content": "Moves an assignment to another learner, published scenario, or both.", "type": "text/plain" }, "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "your_assignment_id", "key": "assignmentId", "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"hFfMhpkZfUd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "189aa157-a6fb-45ee-afae-c9f20a97aed8", "name": "Assignment update result.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"hFfMhpkZfUd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"assignment\": {\n \"id\": \"\",\n \"assignedAt\": \"\",\n \"userId\": \"\",\n \"scenario\": \"\"\n },\n \"changed\": \"\",\n \"emailSent\": \"\",\n \"practiceUrl\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d2edcb0-558d-4cb7-ac6a-6bbddd57c72e", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"hFfMhpkZfUd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e53029ee-28aa-404f-8d69-4b4cb88851a1", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"hFfMhpkZfUd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39e54323-2863-4c0b-8da2-c9cda8082e62", "name": "API key creator is no longer an organization trainer.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"hFfMhpkZfUd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cce82695-a4c7-40cb-b9ca-5eeea180296f", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"hFfMhpkZfUd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9abe10c5-3842-4337-8eb9-4edeeaa5e19c", "name": "Request conflicts with existing organization data.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"hFfMhpkZfUd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8d855ed1-3178-4234-a5ab-0b907724035d", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"hFfMhpkZfUd\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b78e4b55-a62c-45b5-922f-f59d217b808b", "name": "Delete an assignment", "request": { "name": "Delete an assignment", "description": {}, "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "your_assignment_id", "key": "assignmentId", "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "fdcf1ca4-df81-40ec-ac88-73ed48be2041", "name": "Assignment deleted.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "0d5f1da6-6144-4681-8867-82c7751f9807", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e94b0ec4-ff7b-4fb4-88da-3f6dad8613f7", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf483a70-7f33-43e3-8969-553236e53b7b", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "assignments", ":assignmentId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Assignment ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "assignmentId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "sessions", "description": "", "item": [ { "id": "428d4d08-ee80-453d-be23-d651047b9edc", "name": "List sessions", "request": { "name": "List sessions", "description": { "content": "Lists practice-session summaries. Use the detail endpoint for transcript and evidence data.", "type": "text/plain" }, "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of assigned,activating,active,completed,abandoned,failed,revoked)", "type": "text/plain" }, "key": "status", "value": "activating" }, { "disabled": false, "description": { "content": "Filter by learner user ID.", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "Filter by published scenario slug.", "type": "text/plain" }, "key": "scenario", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or after this ISO 8601 timestamp.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or before this ISO 8601 timestamp.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "cb3b0333-8d27-4268-b1e1-e6fbdf9ad8cd", "name": "Practice sessions.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of assigned,activating,active,completed,abandoned,failed,revoked)", "type": "text/plain" }, "key": "status", "value": "activating" }, { "disabled": false, "description": { "content": "Filter by learner user ID.", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "Filter by published scenario slug.", "type": "text/plain" }, "key": "scenario", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or after this ISO 8601 timestamp.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or before this ISO 8601 timestamp.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"sessions\": [\n {\n \"id\": \"\",\n \"personaSlug\": \"\",\n \"personaVersion\": \"\",\n \"agentSlug\": \"\",\n \"agentVersion\": \"\",\n \"domainSlug\": \"\",\n \"domainVersion\": \"\",\n \"status\": \"abandoned\",\n \"startedAt\": \"\",\n \"userId\": \"\",\n \"mode\": \"voice\",\n \"contextName\": \"\",\n \"createdAt\": \"\",\n \"endedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"personaSlug\": \"\",\n \"personaVersion\": \"\",\n \"agentSlug\": \"\",\n \"agentVersion\": \"\",\n \"domainSlug\": \"\",\n \"domainVersion\": \"\",\n \"status\": \"revoked\",\n \"startedAt\": \"\",\n \"userId\": \"\",\n \"mode\": \"voice\",\n \"contextName\": \"\",\n \"createdAt\": \"\",\n \"endedAt\": \"\"\n }\n ],\n \"pagination\": {\n \"limit\": \"\",\n \"offset\": \"\",\n \"total\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84cd0e74-426d-4884-9be6-97abd26b6744", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of assigned,activating,active,completed,abandoned,failed,revoked)", "type": "text/plain" }, "key": "status", "value": "activating" }, { "disabled": false, "description": { "content": "Filter by learner user ID.", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "Filter by published scenario slug.", "type": "text/plain" }, "key": "scenario", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or after this ISO 8601 timestamp.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or before this ISO 8601 timestamp.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b29bac63-5b58-478b-90d7-2d01326f28d6", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of assigned,activating,active,completed,abandoned,failed,revoked)", "type": "text/plain" }, "key": "status", "value": "activating" }, { "disabled": false, "description": { "content": "Filter by learner user ID.", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "Filter by published scenario slug.", "type": "text/plain" }, "key": "scenario", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or after this ISO 8601 timestamp.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or before this ISO 8601 timestamp.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "771da774-90c6-4516-960b-5be88857a83e", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": " (This can only be one of assigned,activating,active,completed,abandoned,failed,revoked)", "type": "text/plain" }, "key": "status", "value": "activating" }, { "disabled": false, "description": { "content": "Filter by learner user ID.", "type": "text/plain" }, "key": "userId", "value": "" }, { "disabled": false, "description": { "content": "Filter by published scenario slug.", "type": "text/plain" }, "key": "scenario", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or after this ISO 8601 timestamp.", "type": "text/plain" }, "key": "from", "value": "" }, { "disabled": false, "description": { "content": "Only include sessions started at or before this ISO 8601 timestamp.", "type": "text/plain" }, "key": "to", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of records to return.", "type": "text/plain" }, "key": "limit", "value": "50" }, { "disabled": false, "description": { "content": "Number of records to skip.", "type": "text/plain" }, "key": "offset", "value": "0" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2ecce601-9c07-4a9f-a959-25dfcce27e3d", "name": "Start a session", "request": { "name": "Start a session", "description": { "content": "Activates a practice session for a learner against a published scenario (or an\nactive deployment key). The session is created in `active` state; the response\ncarries the credentials needed to connect.\n\nChat mode returns `conversationToken`; voice mode returns a LiveKit\n`participantToken` and `room`. Repeat calls with the same `idempotencyKey`\nreturn the same active session with a fresh token.\n", "type": "text/plain" }, "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"iQO8dtu\",\n \"deploymentKey\": \"\",\n \"mode\": \"chat\",\n \"documentId\": \"\",\n \"idempotencyKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "bfea0632-c781-48f5-add7-115a84495c46", "name": "Session activated.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"iQO8dtu\",\n \"deploymentKey\": \"\",\n \"mode\": \"chat\",\n \"documentId\": \"\",\n \"idempotencyKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session\": {\n \"id\": \"\",\n \"agentSlug\": \"\",\n \"status\": \"failed\",\n \"mode\": \"voice\",\n \"runtimeToken\": \"\"\n },\n \"conversationToken\": \"\",\n \"participantToken\": \"\",\n \"room\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2d86dfb-f235-4c09-af88-76a0ed692edb", "name": "Invalid request.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"iQO8dtu\",\n \"deploymentKey\": \"\",\n \"mode\": \"chat\",\n \"documentId\": \"\",\n \"idempotencyKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1071a4cc-d364-47d5-9ab8-bccdba510bc0", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"iQO8dtu\",\n \"deploymentKey\": \"\",\n \"mode\": \"chat\",\n \"documentId\": \"\",\n \"idempotencyKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00fcb65c-5e8e-426b-939d-35f0a92449e0", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"iQO8dtu\",\n \"deploymentKey\": \"\",\n \"mode\": \"chat\",\n \"documentId\": \"\",\n \"idempotencyKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9f8fb4c2-917e-4747-a030-754b35951221", "name": "Request conflicts with existing organization data.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"iQO8dtu\",\n \"deploymentKey\": \"\",\n \"mode\": \"chat\",\n \"documentId\": \"\",\n \"idempotencyKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "082a9d97-101d-498c-9149-24087713a07b", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "sessions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"userId\": \"\",\n \"scenario\": \"iQO8dtu\",\n \"deploymentKey\": \"\",\n \"mode\": \"chat\",\n \"documentId\": \"\",\n \"idempotencyKey\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{sessionId}", "description": "", "item": [ { "id": "51562036-e36f-4f34-b665-8a466657ad09", "name": "Get a session", "request": { "name": "Get a session", "description": { "content": "Returns pinned configuration versions, transcript, evidence, and a presigned download URL for the recording when available.", "type": "text/plain" }, "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "your_session_id", "key": "sessionId", "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "3c782bf3-d44b-415c-86dc-007f2c4c9081", "name": "Session details.", "originalRequest": { "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"session\": {\n \"id\": \"\",\n \"personaSlug\": \"\",\n \"personaVersion\": \"\",\n \"agentSlug\": \"\",\n \"agentVersion\": \"\",\n \"domainSlug\": \"\",\n \"domainVersion\": \"\",\n \"status\": \"abandoned\",\n \"startedAt\": \"\",\n \"userId\": \"\",\n \"mode\": \"chat\",\n \"contextName\": \"\",\n \"createdAt\": \"\",\n \"endedAt\": \"\",\n \"transcript\": null,\n \"evidence\": null,\n \"audioUrl\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae8b8cf8-8850-4da1-b0fe-90fae20e22f5", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fab4457c-5d08-4026-94ea-2bf523c3955a", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4dfec659-5b91-4c88-846b-bfe62a67f9a2", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "df9b1d10-dcaf-4ca1-aa11-3c304fdf6c0f", "name": "Delete a session", "request": { "name": "Delete a session", "description": { "content": "Soft-deletes the session. It is hidden from list and detail responses; the record is retained for auditing.", "type": "text/plain" }, "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "your_session_id", "key": "sessionId", "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": null }, "response": [ { "id": "86eab8db-d85e-45c0-8427-7da67b929327", "name": "Session deleted.", "originalRequest": { "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "079be568-8d86-4593-a5dd-c8e7ce9b8276", "name": "Missing, invalid, expired, or revoked API key.", "originalRequest": { "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bc5e8f4e-4e26-44df-ac2c-dc408ecd6b9c", "name": "Resource not found in the API key's organization.", "originalRequest": { "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f272f2df-e0fb-4b98-a854-76ee9a4ba97b", "name": "API key exceeded 120 requests per minute.", "originalRequest": { "url": { "path": [ "sessions", ":sessionId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) Practice-session ID.", "type": "text/plain" }, "type": "any", "value": "", "key": "sessionId" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "x-api-key", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "apiKey", "type": "string", "value": "tt_your_api_key", "description": "Organization API key generated in Dashboard → account menu → Developer API (dash.trainertwin.com/developer). Shown once — store it before closing the page." }, { "key": "baseUrl", "value": "https://dash.trainertwin.com/api/v1" } ], "info": { "_postman_id": "8b609760-ca67-4567-9252-72db440d5573", "name": "TrainerTwin API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Organization-scoped API for managing learners, practice sessions, and role-play assignments.\nScenarios can be listed via the API; scenario, persona, domain, knowledge, and voice\nconfiguration remains dashboard-only.\n", "type": "text/plain" } } }