> ## Documentation Index
> Fetch the complete documentation index at: https://docs.supertoneapi.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List custom voices
> アカウントに登録されているすべてのカスタム（クローン）ボイスを取得します。
このドキュメントは英語の原文から自動翻訳されています。表現に不自然な箇所がある場合があります。正確な内容は[英語の原文](/en/api-reference/endpoints/list-custom-voices)もあわせてご確認ください。
アカウントが所有するカスタムボイスを返します。[Supertone Play](https://play.supertone.ai) で作成したボイスクローン **および** [クローンボイス作成](/ja/api-reference/endpoints/create-cloned-voice) 経由で作成したクローンの両方が含まれ、どちらも同じリストに集約されます。
## エンドポイント
```http theme={"dark"}
GET https://supertoneapi.com/v1/custom-voices
```
## クエリパラメータ
| Name | Required | Description |
| ----------------- | :------: | ---------------------------------- |
| `page_size` | — | 1 ページあたりの件数です。デフォルト `20`、最大 `100`。 |
| `next_page_token` | — | 前回のレスポンスから取得した、次ページ取得用のトークンです。 |
## レスポンス
カスタムボイスオブジェクトの `items` 配列と、オプショナルな `next_page_token` を返します。
## 注意事項
* カスタムボイスは **アカウント単位** で管理されます。API キーで認証したアカウントが所有するボイスのみが表示されます。
* カスタムボイスはプリセットボイスと同じ TTS エンドポイントから呼び出せます。カスタムの `voice_id` を渡すだけで利用可能です。
## 関連項目
クローンボイスの作成、管理、使用方法。
サンプルをアップロードして新しいクローンを登録します。
## OpenAPI
````yaml /openapi.json GET /v1/custom-voices
openapi: 3.0.0
info:
title: Supertone Public API
description: >-
Supertone API is a RESTful API for using our state-of-the-art AI voice
models.
version: 0.9.6
contact: {}
servers:
- url: https://supertoneapi.com
description: Production
security: []
tags:
- name: voices
description: Voice Library API endpoints
- name: custom_voices
description: Custom Voice Management API endpoints
- name: text_to_speech
description: Text-to-Speech API endpoints
- name: usage
description: Usage Analytics API endpoints
paths:
/v1/custom-voices:
get:
tags:
- custom_voices
summary: Gets custom (cloned) voices
description: >-
Gets a paginated list of custom (cloned) voices available to the user,
using token-based pagination.
operationId: list_custom_voices
parameters:
- name: page_size
required: false
in: query
description: 'Number of items per page (default: 20, min: 10, max: 100)'
schema:
type: number
- name: next_page_token
required: false
in: query
description: Token for pagination (obtained from the previous page's response)
schema:
type: string
responses:
'200':
description: Paginated custom voices response with next page token
content:
application/json:
schema:
$ref: '#/components/schemas/GetCustomVoiceListResponse'
'401':
description: 'Unauthorized: Invalid API key'
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedErrorResponse'
'404':
description: 'Not Found: No custom voices found'
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorResponse'
'500':
description: 'Internal Server Error: Failed to get custom voices'
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorResponse'
security:
- api-key: []
components:
schemas:
GetCustomVoiceListResponse:
type: object
properties:
items:
description: List of custom voice items
type: array
items:
$ref: '#/components/schemas/GetCustomVoiceResponse'
total:
type: number
description: Total number of available custom voices
example: 25
next_page_token:
type: string
description: >-
Token for fetching the next page of results. A valid non-negative
integer string (e.g., "10", "20"). Null if no more pages.
example: '10'
required:
- items
- total
UnauthorizedErrorResponse:
type: object
properties:
status:
type: string
description: Response status
example: error
message:
description: Unauthorized error details
example:
message: Invalid API Key
error: Unauthorized
statusCode: 401
allOf:
- $ref: '#/components/schemas/ErrorMessageData'
required:
- status
- message
NotFoundErrorResponse:
type: object
properties:
status:
type: string
description: Response status
example: error
message:
description: Not found error details
example:
message: Voice not found
error: Not Found
statusCode: 404
allOf:
- $ref: '#/components/schemas/ErrorMessageData'
required:
- status
- message
InternalServerErrorResponse:
type: object
properties:
status:
type: string
description: Response status
example: error
message:
description: Internal server error details
example:
message: Failed to convert text to speech
error: Internal Server Error
statusCode: 500
allOf:
- $ref: '#/components/schemas/ErrorMessageData'
required:
- status
- message
GetCustomVoiceResponse:
type: object
properties:
voice_id:
type: string
description: Unique identifier for the voice
example: voice_123456789
name:
type: string
description: Name of the voice
example: My Custom Voice
description:
type: string
description: Description of the voice
example: A warm and friendly voice for customer service
nullable: true
required:
- voice_id
- name
ErrorMessageData:
type: object
properties:
message:
type: string
description: Error message
example: Invalid API Key
error:
type: string
description: Error type
example: Unauthorized
status_code:
type: number
description: HTTP status code
example: 401
required:
- message
- error
- status_code
securitySchemes:
api-key:
type: apiKey
in: header
name: x-sup-api-key
````