POST /cloud/v2/universes/{universe_id}:generateSpeechAsset — cloud.docs

Generate Speech Asset

Generates an English speech audio asset from the specified text.

This endpoint requires the asset:read and asset:write scopes in addition to the universe:write scope.

The response returns an Operation object that must be prefixed with /assets/v1. For example, the URL to discover the result of the operation could be https://apis.roblox.com/assets/v1/operations/8b42ef30-9c17-4526-b8cf-2ff0136ca94d.

Endpoint

Method: POST

Path: /cloud/v2/universes/{universe_id}:generateSpeechAsset

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/GenerateSpeechAssetRequest"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK

{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Operation"
        }
      }
    }
  }
}

Authentication

{
  "security": [],
  "securitySchemes": {}
}

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Generate Speech Asset",
  "description": "Generates an English speech audio asset from the specified text.\n\nThis endpoint requires the `asset:read` and `asset:write` scopes in\naddition to the `universe:write` scope.\n\nThe response returns an `Operation` object that must be prefixed with\n`/assets/v1`. For example, the URL to discover the result of the operation\ncould be\n`https://apis.roblox.com/assets/v1/operations/8b42ef30-9c17-4526-b8cf-2ff0136ca94d`.",
  "operationId": "Cloud_GenerateSpeechAsset",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/GenerateSpeechAssetRequest"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Operation"
          }
        }
      }
    }
  },
  "x-long-running-operation-parameters": {
    "metadata": {
      "$ref": "#/components/schemas/GenerateSpeechAssetMetadata"
    },
    "response": {
      "$ref": "#/components/schemas/GenerateSpeechAssetResponse"
    }
  },
  "x-visibility": "BETA",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "universe:write"
    },
    {
      "name": "asset:read"
    },
    {
      "name": "asset:write"
    }
  ],
  "x-roblox-docs": {
    "category": "Universes and places",
    "methodProperties": {
      "scopes": [
        "universe:write",
        "asset:read",
        "asset:write"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/Universe",
      "name": "Universe"
    }
  }
}