{ "openapi": "3.1.0", "jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema", "info": { "title": "ForeverLearning Conversations API", "version": "2026-12-01", "description": "Contract for the Conversations API (conversation-practice-v1), released October 25, 2026. Negotiated only by an assigned Conversation release. Existing CLUE and project-planning requests keep developer-runtime.openapi.json. The integration guide at https://developers.foreverlearning.ai/docs/conversation-practice covers recovery, billing, limits and lifecycle." }, "servers": [ { "url": "https://developers-api.foreverlearning.ai", "description": "Production" }, { "url": "https://developers-api-staging.foreverlearning.ai", "description": "Staging" } ], "paths": { "/v1/conversation/catalog": { "get": { "operationId": "conversationCatalog", "summary": "Read the assigned room, persona and control catalog", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Catalog" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/sessions": { "post": { "operationId": "conversationCreateSession", "summary": "Prepare an immutable practice setup without generation", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/CreateSession" } } } }, "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Session" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } }, "get": { "operationId": "conversationList", "summary": "Read prepared and saved practice sessions", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/SessionList" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/sessions/{session_id}": { "get": { "operationId": "conversationSession", "summary": "Read the immutable session setup and current status", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Session" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/sessions/{session_id}/consent": { "post": { "operationId": "conversationConsent", "summary": "Record a terminal continue or soften choice without generation", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ConsentRequest" } } } }, "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ConsentStatus" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } }, "get": { "operationId": "conversationConsentStatus", "summary": "Read the current consent posture", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ConsentStatus" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/data/export": { "post": { "operationId": "conversationExport", "summary": "Export paginated session and turn records using data:export scope", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Export" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/chat": { "post": { "operationId": "conversationChat", "summary": "Generate an opening or a learner turn under the Conversation capability", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ChatRequest" } } } }, "responses": { "200": { "description": "SSE JSON data frames. Only conversation_turn follows durable commit; done carries settlement. Display completion alone proves neither.", "content": { "text/event-stream": { "schema": { "type": "string" }, "x-event-schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/StreamEvent" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/sessions/{session_id}/playback": { "get": { "operationId": "conversationPlayback", "summary": "Read committed turns in chronological pages", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Playback" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/sessions/{session_id}/debrief": { "get": { "operationId": "conversationDebrief", "summary": "Read evidence from a completed practice", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Debrief" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/insights": { "get": { "operationId": "conversationInsights", "summary": "Read observations within the same user and comparable setup", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Insights" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/voice": { "post": { "operationId": "conversationVoice", "summary": "Generate all authorized cast speech and spoken coaching for one committed turn", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/VoiceRequest" } } } }, "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Audio" } } } }, "202": { "description": "Generation is pending. Continue POST with exactly the original request and idempotency key. GET only observes saved state.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Audio" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/sessions/{session_id}/audio": { "get": { "operationId": "conversationAudioList", "summary": "Discover saved generations without generating or purchasing speech", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/AudioList" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/audio/{audio_id}": { "get": { "operationId": "conversationAudio", "summary": "Read generation status and authorized audio segment references", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "audio_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Audio" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/audio/{audio_id}/continue": { "post": { "operationId": "conversationAudioContinue", "summary": "Continue the existing generation with chat and sessions:read authority; never create another purchase", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "audio_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Audio" } } } }, "202": { "description": "The same generation remains pending. Retry this continuation after Retry-After. Each request advances at most one segment.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Audio" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/conversation/audio/{audio_id}/segments/{segment_id}": { "get": { "operationId": "conversationAudioSegment", "summary": "Replay saved audio without synthesis or another charge", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "audio_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "segment_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Authenticated private MP3. Expires 24 hours after original creation; reads never extend expiry.", "headers": { "Cache-Control": { "schema": { "const": "private, no-store" } }, "X-Content-Type-Options": { "schema": { "const": "nosniff" } } }, "content": { "audio/mpeg": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/requests/{request_id}": { "$ref": "./developer-runtime.openapi.json#/paths/~1v1~1requests~1{request_id}" }, "/v1/sessions": { "$ref": "./developer-runtime.openapi.json#/paths/~1v1~1sessions" }, "/v1/session/status": { "$ref": "./developer-runtime.openapi.json#/paths/~1v1~1session~1status" }, "/v1/sessions/{session_id}/history": { "$ref": "./developer-runtime.openapi.json#/paths/~1v1~1sessions~1{session_id}~1history" }, "/v1/sessions/{session_id}/end": { "$ref": "./developer-runtime.openapi.json#/paths/~1v1~1sessions~1{session_id}~1end" }, "/v1/sessions/{session_id}/discard": { "post": { "operationId": "conversationDiscard", "summary": "Revoke content access immediately and complete after private audio cleanup", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleRequest" } } } }, "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleResult" } } } }, "202": { "description": "Content is unreadable; private object cleanup is pending. Repeat the identical operation UUID to check completion.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleResult" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/sessions/{session_id}": { "delete": { "operationId": "conversationDelete", "summary": "Revoke content access immediately and complete after private audio cleanup", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } }, { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleRequest" } } } }, "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleResult" } } } }, "202": { "description": "Content is unreadable; private object cleanup is pending. Repeat the identical operation UUID to check completion.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleResult" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } }, "/v1/data/export": { "$ref": "./developer-runtime.openapi.json#/paths/~1v1~1data~1export" }, "/v1/data/erase": { "post": { "operationId": "conversationErase", "summary": "Revoke content access immediately and complete after private audio cleanup", "security": [ { "DeveloperKey": [] } ], "parameters": [ { "name": "X-User-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Assignment-Id", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "FL-API-Version", "in": "header", "required": false, "schema": { "const": "2026-12-01" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleRequest" } } } }, "responses": { "200": { "description": "Authorized saved result. No generation charge for a read.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleResult" } } } }, "202": { "description": "Content is unreadable; private object cleanup is pending. Repeat the identical operation UUID to check completion.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleResult" } } } }, "400": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "401": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "402": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "403": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "404": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "409": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "410": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "422": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "429": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } }, "503": { "description": "Safe operation error; an interrupted request is recovered with its original identity.", "content": { "application/json": { "schema": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" } } } } } } } }, "components": { "securitySchemes": { "DeveloperKey": { "type": "http", "scheme": "bearer", "description": "Scoped server-side developer key. Never put it in a browser bundle." } }, "schemas": { "ReviewReference": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ReviewReference" }, "ReviewClaim": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ReviewClaim" }, "ReviewMarker": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ReviewMarker" }, "ReviewPattern": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ReviewPattern" }, "ReviewIdentity": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ReviewIdentity" }, "ReviewComparison": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ReviewComparison" }, "PersonaResponseCode": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/PersonaResponseCode" }, "PersonaResponseArcs": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/PersonaResponseArcs" }, "CoachingCloseout": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/CoachingCloseout" }, "ConsumerDebrief": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ConsumerDebrief" }, "ConsumerInsights": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ConsumerInsights" }, "Id": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Id" }, "Timestamp": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Timestamp" }, "Hash": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Hash" }, "Cursor": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Cursor" }, "Controls": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Controls" }, "SetupControls": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/SetupControls" }, "AppliedControls": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/AppliedControls" }, "Participant": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Participant" }, "Consent": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Consent" }, "ConsentRequest": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ConsentRequest" }, "ConsentStatus": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ConsentStatus" }, "LearnerRole": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LearnerRole" }, "RoomSetup": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/RoomSetup" }, "OpenSetup": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/OpenSetup" }, "CreateSession": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/CreateSession" }, "Opening": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Opening" }, "LearnerTurn": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LearnerTurn" }, "ChatRequest": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ChatRequest" }, "LifecycleRequest": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleRequest" }, "LifecycleResult": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/LifecycleResult" }, "VoiceRequest": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/VoiceRequest" }, "CastMember": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/CastMember" }, "Session": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Session" }, "SessionList": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/SessionList" }, "ExportSession": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ExportSession" }, "ExportTurn": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ExportTurn" }, "ExportPreferences": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ExportPreferences" }, "ExportMemory": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ExportMemory" }, "ExportAudio": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/ExportAudio" }, "Export": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Export" }, "Segment": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Segment" }, "Coach": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Coach" }, "Character": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Character" }, "Safety": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Safety" }, "Turn": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Turn" }, "Meter": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Meter" }, "Receipt": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Receipt" }, "Playback": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Playback" }, "EvidenceReference": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/EvidenceReference" }, "Observation": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Observation" }, "Debrief": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Debrief" }, "Insights": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Insights" }, "AudioSegment": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/AudioSegment" }, "AudioSummary": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/AudioSummary" }, "AudioList": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/AudioList" }, "Audio": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Audio" }, "Room": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Room" }, "Persona": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Persona" }, "Option": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Option" }, "Catalog": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Catalog" }, "Error": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/Error" }, "StreamEvent": { "$ref": "https://developers.foreverlearning.ai/schemas/conversation-v1.json#/$defs/StreamEvent" } } } }