> ## Documentation Index > Fetch the complete documentation index at: https://developer.mogl.online/llms.txt > Use this file to discover all available pages before exploring further. # Preview a registered scenario without side effects > Requires one current non-deleted brand and at least one current non-deleted athlete. IDs and roles are resolved again from the database. Definition-specific options are allowlisted. The definition supplies the same compensation, deliverable, included-content, record, date, state, skipped-check, warning, notification, and feature-gate metadata used by creation. Database work performed by a preview definition is always rolled back; preview definitions must not perform file, message, notification, or AI side effects. ## OpenAPI ````yaml /storage/api-docs/api-docs.json post /internal/qa-scenario-lab/preview openapi: 3.0.0 info: title: MOGL Core API description: >- MOGL Platform Core API — powering athlete NIL deals, brand partnerships, agent management, payments, messaging, and more. * * ## Authentication * - **JWT Bearer Token**: Most endpoints require a Bearer token obtained via `/api/login`. * - **Server-to-Server API Key**: Internal/lambda/cron endpoints use an `X-API-KEY` header. * * ## Rate Limiting * - Registration & login endpoints: 4–15 requests per minute * - Public/influencer endpoints: 200 requests per minute * - Authenticated endpoints: standard Laravel throttle version: 1.0.0 servers: - url: http://localhost/mogl/mogl-backend/api description: Local - url: https://dev-api.mogl.online/api description: Dev - url: https://staging-api.mogl.online/api description: Staging - url: https://api.mogl.online/api description: Production security: - bearerAuth: [] tags: - name: Authentication description: Login, registration, password reset - name: User Registration - Common description: Common user registration & email check - name: User Registration - Athlete description: Athlete registration & onboarding steps - name: User Registration - Partner description: Partner/Brand registration & onboarding steps - name: User Registration - Agent description: Agent registration & onboarding steps - name: User Registration - Fan description: Fan registration & onboarding steps - name: User Profile description: User profile management, settings, social media - name: Athlete description: 'Athlete-specific endpoints: search, details, availability' - name: Athlete - Availability Confirmation description: Post-hiring availability confirmation workflow - name: Athlete - NIL Feed description: Athlete NIL feed and partner search - name: Athlete - AI Assistant description: >- AI-powered job assistant for athletes — chat, conversation history, read state, and clarification drafts - name: Athlete - AI Waitlist description: AI Athlete Assistant waitlist status, social proof, and joining - name: Partner description: Partner/Brand-specific endpoints - name: Partner - External Job description: External job link & applicant management - name: Partner - Deliverable Report description: Deliverable detail reports for brands - name: Partner - Screening Questions description: Screening question reports - name: Partner - Contract Management description: Brand contract management with athletes - name: Partner - Content Library description: Brand content library for deliverable assets - name: Agent description: Agent profile, athlete management, contracts - name: Agent - Athletes description: Agent-athlete relationship management - name: Agent - Stripe description: Agent payment methods & billing via Stripe - name: Agent - Pay description: 'Agent-wide payout feed: money MOGL sends the agent through Stripe Express' - name: Agent - Contracts description: Agent athlete contract management - name: Agent - Availability Confirmation description: Agent managing athlete job availability - name: Agent - Roster Import description: >- CSV client list import through CSVBox (ENG-1619 / ENG-1702): session, CSVBox webhook, progress, row results, retry - name: Agent - Roster Pages description: >- ENG-1685: My Roster Link, public roster directory, public roster page, and roster SEO URL resolution. A roster is the agent's current linked athletes; nothing is stored separately. - name: Jobs description: Job/deal CRUD, search, invitations, hiring, deliverables - name: Deals description: Deal listing, my deals, bulk operations - name: Deal Folder description: >- Deal folder file workflow — uploads, replacements, approvals, revisions, comments. Accessible by athlete, partner/brand, agent, and iOS clients (per-action authorisation enforced server-side). - name: Deal Folder iOS API description: >- iOS-only direct-to-S3 multipart upload endpoints for deal folder files (initiate/complete for new uploads and replacements). Web clients should use the standard `Deal Folder` upload/replace endpoints instead. - name: Chat description: Messaging, chat contacts, notifications - name: Notifications description: Notification preferences, in-app notifications - name: Payments description: Stripe payments, payment history, cards, bulk pay - name: Subscription description: Brand subscription plans & management - name: Public Pages description: Public content endpoints (no auth required) - name: Public - Influencer/SEO description: Public influencer discovery, sitemaps, directories - name: Services description: Athlete service marketplace - name: iOS Device description: iOS device tokens, live activities - name: Onboarding Tutorial description: Onboarding tutorial progress - name: MOGL Rosters description: Roster management & display - name: Internal / Cron description: Server-to-server and cron job endpoints - name: Internal / AI Assistant Tools description: >- Server-to-server Athlete Assistant tool gateway used by mogl-ai-service. Eight Laravel tools share POST /internal/ai-assistant/tools/{tool}. search_kb is Python-local and is not in this path enum. - name: Internal / QA Scenario Lab description: >- Feature-flagged DEV/STAGING-only endpoints called by the authorized Back Office QA Scenario Lab. - name: Affiliate description: Athlete affiliate links & tracking - name: Internal description: Internal - name: Public - Social Linking description: Public - Social Linking paths: /internal/qa-scenario-lab/preview: post: tags: - Internal / QA Scenario Lab summary: Preview a registered scenario without side effects description: >- Requires one current non-deleted brand and at least one current non-deleted athlete. IDs and roles are resolved again from the database. Definition-specific options are allowlisted. The definition supplies the same compensation, deliverable, included-content, record, date, state, skipped-check, warning, notification, and feature-gate metadata used by creation. Database work performed by a preview definition is always rolled back; preview definitions must not perform file, message, notification, or AI side effects. operationId: previewQaScenarioLabScenario parameters: - $ref: '#/components/parameters/QaScenarioLabApiKey' - $ref: '#/components/parameters/QaScenarioLabAdminId' - $ref: '#/components/parameters/QaScenarioLabTimestamp' - $ref: '#/components/parameters/QaScenarioLabNonce' - $ref: '#/components/parameters/QaScenarioLabPermission' - $ref: '#/components/parameters/QaScenarioLabSignature' requestBody: required: true content: application/json: schema: required: - scenario_key - scenario_version - brand_id - athlete_ids properties: scenario_key: type: string maxLength: 100 example: application.applied scenario_version: type: integer minimum: 1 example: 1 brand_id: type: integer minimum: 1 example: 1001 athlete_ids: type: array items: type: integer minimum: 1 maxItems: 50 minItems: 1 uniqueItems: true example: - 2001 - 2002 options: maxProperties: 25 type: object additionalProperties: true type: object additionalProperties: false responses: '200': description: Authoritative no-write review. content: application/json: schema: required: - data - meta properties: data: required: - selection_fingerprint - scenario - actors - review properties: selection_fingerprint: type: string maxLength: 64 minLength: 64 scenario: $ref: '#/components/schemas/QaScenarioLabCatalogItem' actors: type: object additionalProperties: true review: type: object additionalProperties: true type: object meta: required: - requested_by_admin_id - reference_time properties: requested_by_admin_id: type: integer minimum: 1 reference_time: type: string format: date-time type: object type: object '401': description: Missing, invalid, or expired credentials. content: application/json: schema: $ref: '#/components/schemas/UnauthorizedResponse' '409': description: Signed nonce was already used. '422': description: Invalid actors, unknown scenario/options, or malformed input. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' security: - serverToServerApiKey: [] qaScenarioLabSignature: [] components: parameters: QaScenarioLabApiKey: name: X-API-KEY in: header description: Dedicated QA Scenario Lab service credential. required: true schema: type: string QaScenarioLabAdminId: name: X-QA-Lab-Admin-Id in: header description: >- Positive initiating Back Office administrator ID included in the signature. required: true schema: type: integer minimum: 1 example: 42 QaScenarioLabTimestamp: name: X-QA-Lab-Timestamp in: header description: Ten-digit Unix timestamp. Default maximum age is 300 seconds. required: true schema: type: integer format: int64 example: 1791194024 QaScenarioLabNonce: name: X-QA-Lab-Nonce in: header description: One-use UUID included in the signature. required: true schema: type: string format: uuid QaScenarioLabPermission: name: X-QA-Lab-Permission in: header description: Signed permission claim. required: true schema: type: string enum: - qa_scenario_lab QaScenarioLabSignature: name: X-QA-Lab-Signature in: header description: Lowercase hexadecimal HMAC-SHA256 of the canonical request envelope. required: true schema: type: string maxLength: 64 minLength: 64 pattern: ^[a-f0-9]{64}$ schemas: QaScenarioLabCatalogItem: required: - key - version - display_name - description - compensation - deliverable_count_per_athlete - included_content properties: key: type: string example: application.applied version: type: integer minimum: 1 example: 1 display_name: type: string example: Applied description: type: string compensation: type: object additionalProperties: true deliverable_count_per_athlete: description: >- Number of shared job deliverable templates visible to each selected athlete. For Applied scenarios these are not athlete-specific milestone relationships; those begin when the athlete is hired and signs the agreement. type: integer minimum: 0 example: 3 included_content: properties: fixture_files: type: boolean brand_chat: type: boolean assistant: type: boolean type: object evaluation_correlation: description: >- Present and true only for scenarios whose runs accept qa_scenario_run_id Assistant chat correlation: evaluation.recent_hire_support_escalation@1, files.mixed_deliverables@1, files.needs_review@1, and files.revision_requested@1. Runners check it before creating replay fixtures. type: boolean example: true evaluation_case_ref: description: >- Ordered evaluation case that replays this scenario. Present only with evaluation_correlation. type: string example: files_need_review_two_turn_v1 ordered_turn_count: description: >- Number of ordered Assistant turns in that evaluation case. Present only with evaluation_correlation. type: integer minimum: 1 example: 2 type: object UnauthorizedResponse: properties: message: type: string example: Unauthenticated. type: object ValidationErrorResponse: properties: message: type: string example: The given data was invalid. errors: type: object additionalProperties: type: array items: type: string type: object securitySchemes: bearerAuth: type: http description: >- JWT Bearer token authentication. Use the /api/login endpoint to obtain a token. scheme: bearer bearerFormat: JWT serverToServerApiKey: type: apiKey description: Server-to-Server API Key for internal/lambda/cron calls name: X-API-KEY in: header qaScenarioLabSignature: type: apiKey description: >- HMAC-SHA256 signature for a one-use, short-lived Back Office administrator envelope. Used together with the dedicated X-API-KEY credential and the signed administrator, timestamp, nonce, and permission headers. name: X-QA-Lab-Signature in: header ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.