Moonscale · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the Moonscale API

9 actions 9 updates documentation extends openapi/moonscale-openapi-original.json
Generated by API Evangelist Written by API Evangelist tooling for Moonscale's API. It is a proposal applied on top of the contract, not a document Moonscale publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdcontactx-documentationx-former-namex-apievangelist-enrichedx-agentic-accesstypedescription

Targets 9

$.servers
$.info
$.tags
$.paths['/api/v1/rooms'].post
$.paths['/api/v1/conversations/{conversationShortCode}'].get
$.paths['/api/studio-avatar/generate-video'].post
$.paths['/api/studio-avatar/generated-video/{correlationId}'].get
$.components.schemas.ApiLiveAvatarConversationsResponse.properties.transcript
$.components.securitySchemes.ApiKeyAuth

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for the Moonscale API
  version: 1.0.0
extends: openapi/moonscale-openapi-original.json
x-generated: '2026-08-14'
x-method: generated
x-source: >-
  Derived from the verbatim spec at
  https://vidlab7-d7584a5d.mintlify.app/api-reference/openapi.json plus Moonscale's own
  published reference and live probes of https://api-prd.moonscale.com. Every value below
  is sourced from a Moonscale-published document or a directly observed response; nothing
  is invented. The harvested original is never mutated.
actions:
- target: $.servers
  description: >-
    The published spec's only server is http://sandbox.mintlify.com — the Mintlify
    documentation-template default, over plain HTTP, on a host Moonscale does not own. A
    client generated from the spec as published sends its requests to Mintlify's demo
    sandbox. The real production host is named throughout Moonscale's own reference and was
    verified live (HTTP 401 with a Moonscale error envelope on /health).
  update:
  - url: https://api-prd.moonscale.com
    description: Production. Verified live 2026-08-14; unauthenticated requests return 401 {"message":"Unauthorized request. No API key provided."}
  - url: https://api-prd.vidlab7.com
    description: Pre-rename alias, still live and still targeted by the third-party Activepieces connector. No deprecation or sunset notice is published for it.
- target: $.info
  update:
    contact:
      name: Moonscale Support
      email: support@moonscale.com
      url: https://www.moonscale.com/contact
    x-documentation: https://vidlab7-d7584a5d.mintlify.app/api-reference/introduction
    x-former-name: VidLab7
    x-apievangelist-enriched: '2026-08-14'
- target: $.tags
  description: The spec tags every operation but never declares the tag objects at the root.
  update:
  - name: liveAvatar
    description: Real-time conversational sales avatars — meeting rooms, transcripts and summaries.
  - name: videoGeneration
    description: Asynchronous studio-avatar video rendering from a script and a voice.
- target: $.paths['/api/v1/rooms'].post
  description: Add the operationId the spec omits, so generated clients get a stable method name.
  update:
    operationId: createRoom
- target: $.paths['/api/v1/conversations/{conversationShortCode}'].get
  update:
    operationId: getConversation
- target: $.paths['/api/studio-avatar/generate-video'].post
  update:
    operationId: generateVideo
    x-agentic-access:
      action-class: acting
      consequence: write
      audit: required
      note: Starts a billable asynchronous render. No idempotency contract is published, so a retried request may produce a second video.
- target: $.paths['/api/studio-avatar/generated-video/{correlationId}'].get
  update:
    operationId: getGeneratedVideo
- target: $.components.schemas.ApiLiveAvatarConversationsResponse.properties.transcript
  description: >-
    The published schema declares "type": "Transcript[]", which is not a valid JSON Schema
    type and will be rejected or silently mis-generated by strict tooling. The items
    subschema already present makes the intent unambiguous.
  update:
    type: array
- target: $.components.securitySchemes.ApiKeyAuth
  update:
    description: >-
      API key issued from Moonscale Studio (app.moonscale.com) under API. Shown once at
      creation and permanently hidden afterwards; a lost key must be deleted and reissued.
      API access is feature-flagged per account — accounts without the API section must
      request access from support@moonscale.com.