Hedra Public API

Public endpoints are available to API users.

Operations 9

GET /public/models List Models #
GET /public/voices List Voices #
GET /public/assets List Assets #
POST /public/assets Create Asset #
POST /public/assets/{id}/upload Upload Asset #
GET /public/generations List #
POST /public/generations Generate Asset #
GET /public/generations/{generation_id}/status Get Status #
GET /public/billing/credits Get Credits #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hedra-public-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hedra-public-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Hedra Web Public API
  version: 0.1.0
  description: Public endpoints are available to API users.
servers:
- url: /web-app
tags:
- name: Public
  description: Public endpoints are available to API users.
paths:
  /public/models:
    get:
      tags:
      - Public
      summary: List Models
      operationId: list_models_public_models_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: types
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/GenerationType'
          - type: 'null'
          title: Types
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AIModel'
                title: Response List Models Public Models Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/voices:
    get:
      tags:
      - Public
      summary: List Voices
      operationId: list_voices_public_voices_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Asset'
                type: array
                title: Response List Voices Public Voices Get
      security:
      - APIKeyHeader: []
  /public/assets:
    get:
      tags:
      - Public
      summary: List Assets
      operationId: list_assets_public_assets_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: type
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/AssetType'
      - name: ids
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Ids
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Asset'
                title: Response List Assets Public Assets Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Public
      summary: Create Asset
      operationId: create_asset_public_assets_post
      security:
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAssetRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateAssetResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/assets/{id}/upload:
    post:
      tags:
      - Public
      summary: Upload Asset
      operationId: upload_asset_public_assets__id__upload_post
      security:
      - APIKeyHeader: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Id
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_asset_public_assets__id__upload_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Asset'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/generations:
    get:
      tags:
      - Public
      summary: 'List '
      operationId: list__public_generations_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: type
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AssetType'
          - $ref: '#/components/schemas/GenerationType'
          - type: 'null'
          title: Type
      - name: created_before
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created Before
      - name: created_after
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created After
      - name: prompt_query
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt Query
      - name: agent_thread_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Agent Thread Id
      - name: ids
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Ids
      - name: paging_params
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/PagingParams'
          default:
            limit: 100
            offset: 0
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResponse_Generation_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Public
      summary: Generate Asset
      operationId: generate_asset_public_generations_post
      security:
      - APIKeyHeader: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/GenerateVideoRequest'
              - $ref: '#/components/schemas/GenerateTextToSpeechRequest'
              - $ref: '#/components/schemas/GenerateTextToSoundRequest'
              - $ref: '#/components/schemas/GenerateImageRequest'
              - $ref: '#/components/schemas/GenerateImageUpscaleRequest'
              - $ref: '#/components/schemas/GenerateVideoUpscaleRequest'
              - $ref: '#/components/schemas/GenerateIsolatedAudioRequest'
              - $ref: '#/components/schemas/GenerateSpeechToSpeechRequest'
              - $ref: '#/components/schemas/GenerateVoiceCloneRequest'
              - $ref: '#/components/schemas/GenerateVideoToVideoRequest'
              - $ref: '#/components/schemas/GenerateMotionControlRequest'
              discriminator:
                propertyName: type
                mapping:
                  video: '#/components/schemas/GenerateVideoRequest'
                  text_to_speech: '#/components/schemas/GenerateTextToSpeechRequest'
                  text_to_sound: '#/components/schemas/GenerateTextToSoundRequest'
                  image: '#/components/schemas/GenerateImageRequest'
                  image_to_image: '#/components/schemas/GenerateImageRequest'
                  image_upscale: '#/components/schemas/GenerateImageUpscaleRequest'
                  video_upscale: '#/components/schemas/GenerateVideoUpscaleRequest'
                  audio_isolation: '#/components/schemas/GenerateIsolatedAudioRequest'
                  speech_to_speech: '#/components/schemas/GenerateSpeechToSpeechRequest'
                  voice_clone: '#/components/schemas/GenerateVoiceCloneRequest'
                  video_to_video: '#/components/schemas/GenerateVideoToVideoRequest'
                  motion_control: '#/components/schemas/GenerateMotionControlRequest'
              title: Generate Request
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/GenerateVideoResponse'
                - $ref: '#/components/schemas/GenerateTextToSpeechResponse'
                - $ref: '#/components/schemas/GenerateTextToSoundResponse'
                - $ref: '#/components/schemas/GenerateImageResponse'
                - $ref: '#/components/schemas/GenerateImageUpscaleResponse'
                - $ref: '#/components/schemas/GenerateVideoUpscaleResponse'
                - $ref: '#/components/schemas/GenerateIsolatedAudioResponse'
                - $ref: '#/components/schemas/GenerateSpeechToSpeechResponse'
                - $ref: '#/components/schemas/GenerateVoiceCloneResponse'
                - $ref: '#/components/schemas/GenerateVideoToVideoResponse'
                - $ref: '#/components/schemas/GenerateMotionControlResponse'
                discriminator:
                  propertyName: type
                  mapping:
                    video: '#/components/schemas/GenerateVideoResponse'
                    text_to_speech: '#/components/schemas/GenerateTextToSpeechResponse'
                    text_to_sound: '#/components/schemas/GenerateTextToSoundResponse'
                    image: '#/components/schemas/GenerateImageResponse'
                    image_to_image: '#/components/schemas/GenerateImageResponse'
                    image_upscale: '#/components/schemas/GenerateImageUpscaleResponse'
                    video_upscale: '#/components/schemas/GenerateVideoUpscaleResponse'
                    audio_isolation: '#/components/schemas/GenerateIsolatedAudioResponse'
                    speech_to_speech: '#/components/schemas/GenerateSpeechToSpeechResponse'
                    voice_clone: '#/components/schemas/GenerateVoiceCloneResponse'
                    video_to_video: '#/components/schemas/GenerateVideoToVideoResponse'
                    motion_control: '#/components/schemas/GenerateMotionControlResponse'
                title: Response Generate Asset Public Generations Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/generations/{generation_id}/status:
    get:
      tags:
      - Public
      summary: Get Status
      operationId: get_status_public_generations__generation_id__status_get
      security:
      - APIKeyHeader: []
      parameters:
      - name: generation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Generation Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerationStatusResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /public/billing/credits:
    get:
      tags:
      - Public
      summary: Get Credits
      operationId: get_credits_public_billing_credits_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditBalance'
      security:
      - APIKeyHeader: []
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    GenerationType:
      type: string
      enum:
      - image
      - video
      - text_to_speech
      - speech_to_speech
      - voice_clone
      - audio_isolation
      - video_stitching
      - video_upscale
      - video_to_video
      - image_upscale
      - agent_response
      - audio_from_video
      - text_to_sound
      - assets_to_image_text_prompt
      - assets_to_audio_text_prompt
      title: GenerationType
      description: 'Generation type enum


        NOTE: this enum is used to determine the type of generation and is used to determine

        the type of asset that will be generated.'
    GenerateVoiceCloneResponse:
      properties:
        workspace_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Workspace Id
        agent_thread_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Agent Thread Id
          description: Optional agent thread ID to associate this generation with.
        generation_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Generation Id
          description: Optional pre-reserved generation ID. If provided, this ID will be used instead of generating a new one. For batch operations (batch_size > 1), use generation_ids instead.
        generation_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Generation Ids
          description: Optional list of pre-reserved generation IDs for batch operations. Length must match batch_size. Mutually exclusive with generation_id.
        reserved_asset_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Reserved Asset Id
          description: Optional pre-reserved asset ID. Used as the produced media+asset resource_id so the client knows the asset's identity at request time. For batch operations (batch_size > 1), use reserved_asset_ids instead. Named distinctly from the response's `asset_id` (the produced asset) so the two don't collide across the request/response inheritance chain — mirrors generation_id (request) vs id (response).
        reserved_asset_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Reserved Asset Ids
          description: Optional list of pre-reserved asset IDs for batch operations. Length must match batch_size, parallel to generation_ids. Mutually exclusive with reserved_asset_id.
        type:
          type: string
          const: voice_clone
          title: Type
          default: voice_clone
        audio_id:
          type: string
          format: uuid
          title: Audio Id
          description: The id of the Audio asset to use as the basis for the clone.
        name:
          type: string
          title: Name
          description: The name of the new voice. Required by ElevenLabs to create a new voice.
        id:
          type: string
          format: uuid
          title: Id
          description: The id of the generation. Can be used to check status.
        asset_id:
          type: string
          format: uuid
          title: Asset Id
          description: The id of the resulting Voice asset.
        created_at:
          type: string
          title: Created At
          description: Date the generation was submitted.
        status:
          $ref: '#/components/schemas/GenerationStatus'
          description: Status of the generation
        progress:
          type: number
          title: Progress
          description: Current progress to completion. Between 0-1
        eta_sec:
          anyOf:
          - type: integer
          - type: 'null'
          title: Eta Sec
          description: Estimated time until completion in seconds. May be None if no historical data available.
      type: object
      required:
      - audio_id
      - name
      - id
      - asset_id
      - created_at
      - status
      - progress
      title: GenerateVoiceCloneResponse
    GenerationError:
      properties:
        type:
          $ref: '#/components/schemas/ErrorCode'
          description: The class of error encountered.
        message:
          type: string
          title: Message
          description: The error message.
      type: object
      required:
      - type
      - message
      title: GenerationError
    GenerateIsolatedAudioRequest:
      properties:
        workspace_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Workspace Id
        agent_thread_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Agent Thread Id
          description: Optional agent thread ID to associate this generation with.
        generation_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Generation Id
          description: Optional pre-reserved generation ID. If provided, this ID will be used instead of generating a new one. For batch operations (batch_size > 1), use generation_ids instead.
        generation_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Generation Ids
          description: Optional list of pre-reserved generation IDs for batch operations. Length must match batch_size. Mutually exclusive with generation_id.
        reserved_asset_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Reserved Asset Id
          description: Optional pre-reserved asset ID. Used as the produced media+asset resource_id so the client knows the asset's identity at request time. For batch operations (batch_size > 1), use reserved_asset_ids instead. Named distinctly from the response's `asset_id` (the produced asset) so the two don't collide across the request/response inheritance chain — mirrors generation_id (request) vs id (response).
        reserved_asset_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Reserved Asset Ids
          description: Optional list of pre-reserved asset IDs for batch operations. Length must match batch_size, parallel to generation_ids. Mutually exclusive with reserved_asset_id.
        type:
          type: string
          const: audio_isolation
          title: Type
          default: audio_isolation
        audio_id:
          type: string
          format: uuid
          title: Audio Id
          description: The id of the audio asset requiring sound isolation.
        ai_model_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Ai Model Id
          description: Deprecated. Use `model_slug` to select the audio isolation model.
          deprecated: true
        model_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Model Slug
          description: The slug of the model to use for audio isolation. Alternative to `ai_model_id`.
      type: object
      required:
      - audio_id
      title: GenerateIsolatedAudioRequest
    GeneratedVideoInputs:
      properties:
        text_prompt:
          type: string
          title: Text Prompt
          description: Prompt for video generation.
        ai_model_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Ai Model Id
          description: Deprecated. Use `model_slug` to identify the model used for generation.
          deprecated: true
        model_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Model Slug
          description: The slug of the model used for generation. Alternative to `ai_model_id`.
        resolution:
          anyOf:
          - type: string
          - type: 'null'
          title: Resolution
          description: Resolution for the video.
        aspect_ratio:
          anyOf:
          - type: string
          - type: 'null'
          title: Aspect Ratio
          description: Aspect ratio for the video.
        duration_ms:
          anyOf:
          - type: integer
          - type: 'null'
          title: Duration Ms
          description: Duration of the video in milliseconds.
        bounding_box_target:
          anyOf:
          - $ref: '#/components/schemas/NormalizedPoint'
          - items:
              $ref: '#/components/schemas/NormalizedPoint'
            type: array
          - type: 'null'
          title: Bounding Box Target
          description: Normalized coordinates for speaker position(s). A single point for single-speaker; a list for multi-speaker (one per speaker, same length as audio_id list).
        character_orientation:
          anyOf:
          - type: string
            enum:
            - video
            - image
          - type: 'null'
          title: Character Orientation
          description: 'For motion control models: ''video'' matches reference video orientation (better for complex motions, max 30s), ''image'' preserves character image orientation (better for camera movements, max 10s).'
        enhance_prompt:
          type: boolean
          title: Enhance Prompt
          description: If true, automatically enhance the prompt before generation.
          default: false
        multi_prompt:
          anyOf:
          - items:
              $ref: '#/components/schemas/VideoShot'
            type: array
          - type: 'null'
          title: Multi Prompt
          description: List of shots for multi-shot video generation. When provided, text_prompt is ignored and total duration is the sum of shot durations.
        shot_type:
          anyOf:
          - type: string
            const: customize
          - type: 'null'
          title: Shot Type
          description: Shot type for multi-shot generation. Currently only 'customize' is supported.
      type: object
      required:
      - text_prompt
      title: GeneratedVideoInputs
    CreateAssetRequest:
      properties:
        name:
          type: string
          title: Name
          description: Name of the asset. Default to user-provided file name.
        type:
          $ref: '#/components/schemas/AssetType'
          description: The type of the asset.
        workspace_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Workspace Id
        reserved_asset_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Reserved Asset Id
          description: Optional pre-reserved asset ID, used as the produced media+asset resource_id so the client knows the upload's identity before it completes.
      type: object
      required:
      - name
      - type
      title: CreateAssetRequest
    UploadedImage:
      properties:
        type:
          type: string
          const: uploaded_image
          title: Type
          default: uploaded_image
        width:
          type: integer
          title: Width
          description: Width of the image.
        height:
          type: integer
          title: Height
          description: Height of the image.
        url:
          type: string
          title: Url
          description: URL of the image.
      type: object
      required:
      - width
      - height
      - url
      title: UploadedImage
    GenerateImageUpscaleResponse:
      properties:
        workspace_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Workspace Id
        agent_thread_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Agent Thread Id
          description: Optional agent thread ID to associate this generation with.
        generation_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Generation Id
          description: Optional pre-reserved generation ID. If provided, this ID will be used instead of generating a new one. For batch operations (batch_size > 1), use generation_ids instead.
        generation_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Generation Ids
          description: Optional list of pre-reserved generation IDs for batch operations. Length must match batch_size. Mutually exclusive with generation_id.
        reserved_asset_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Reserved Asset Id
          description: Optional pre-reserved asset ID. Used as the produced media+asset resource_id so the client knows the asset's identity at request time. For batch operations (batch_size > 1), use reserved_asset_ids instead. Named distinctly from the response's `asset_id` (the produced asset) so the two don't collide across the request/response inheritance chain — mirrors generation_id (request) vs id (response).
        reserved_asset_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Reserved Asset Ids
          description: Optional list of pre-reserved asset IDs for batch operations. Length must match batch_size, parallel to generation_ids. Mutually exclusive with reserved_asset_id.
        type:
          type: string
          const: image_upscale
          title: Type
          default: image_upscale
        ai_model_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Ai Model Id
          description: Deprecated. Use `model_slug` to select the image upscale model.
          deprecated: true
        model_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Model Slug
          description: The slug of the model to use for upscaling. Alternative to `ai_model_id`.
        image_id:
          type: string
          format: uuid
          title: Image Id
          description: The id of the Image asset to use as the basis for upscaling.
        target_resolution:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Resolution
          description: Target output resolution (e.g. '1080p', '2K', '4K'). Preferred over upscale_factor.
        upscale_factor:
          anyOf:
          - type: number
          - type: 'null'
          title: Upscale Factor
          description: 'Optional upscale factor (e.g. 2.0 for 2x). Deprecated: prefer target_resolution.'
        asset_id:
          type: string
          format: uuid
          title: Asset Id
          description: The id of the resulting image asset.
        id:
          type: string
          format: uuid
          title: Id
          description: The id of the generation. Can be used to check status.
        created_at:
          type: string
          title: Created At
          description: Date the generation was submitted.
        status:
          $ref: '#/components/schemas/GenerationStatus'
          description: Status of the generation
        progress:
          type: number
          title: Progress
          description: Current progress to completion. Between 0-1
        eta_sec:
          anyOf:
          - type: integer
          - type: 'null'
          title: Eta Sec
          description: Estimated time until completion in seconds. May be None if no historical data available.
      type: object
      required:
      - image_id
      - asset_id
      - id
      - created_at
      - status
      - progress
      title: GenerateImageUpscaleResponse
    AssetType:
      type: string
      enum:
      - text
      - image
      - audio
      - video
      - voice
      - three_d
      - rich_text
      title: AssetType
    GenerateTextToSpeechResponse:
      properties:
        workspace_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Workspace Id
        agent_thread_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Agent Thread Id
          description: Optional agent thread ID to associate this generation with.
        generation_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Generation Id
          description: Optional pre-reserved generation ID. If provided, this ID will be used instead of generating a new one. For batch operations (batch_size > 1), use generation_ids instead.
        generation_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Generation Ids
          description: Optional list of pre-reserved generation IDs for batch operations. Length must match batch_size. Mutually exclusive with generation_id.
        reserved_asset_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Reserved Asset Id
          description: Optional pre-reserved asset ID. Used as the produced media+asset resource_id so the client knows the asset's identity at request time. For batch operations (batch_size > 1), use reserved_asset_ids instead. Named distinctly from the response's `asset_id` (the produced asset) so the two don't collide across the request/response inheritance chain — mirrors generation_id (request) vs id (response).
        reserved_asset_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Reserved Asset Ids
          description: Optional list of pre-reserved asset IDs for batch operations. Length must match batch_size, parallel to generation_ids. Mutually exclusive with reserved_asset_id.
        type:
          type: string
          const: text_to_speech
          title: Type
          default: text_to_speech
        name:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Name
          description: Optional human-friendly name for the generated asset.
        voice_id:
          type: string
          format: uuid
          title: Voice Id
          description: The id of the Voice to use.
        model_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Model Id
          description: Deprecated. Use `model_slug` to select the model.
          deprecated: true
        model_slug:
          anyOf:
          - type: string
          - type: 'null'
          title: Model Slug
          description: The slug of the model to use. Alternative to `model_id`.
        text:
          type: string
          title: Text
          description: The text to convert to speech.
        stability:
          type: number
          maximum: 1.0
          minimum: 0.0
          title: Stability
          description: Stability should be between 0-1, where 0 is the most stable and 1 is the most unstable. This varies the consistency between your outputs.
          default: 1.0
        speed:
          type: number
          maximum: 1.2
          minimum: 0.7
          title: Speed
          description: Speed should be between 0.7 and 1.2, where 0.7 is the slowest and 1.2 is the fastest. This varies the speed of the generated speech.
          default: 1.0
        language:
          $ref: '#/components/schemas/SupportedLanguage'
          description: Languag

# --- truncated at 32 KB (157 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hedra/refs/heads/main/openapi/hedra-public-api-openapi.yml