API Reference
SDK Libraries
Endpoints
- Text to Speech
- Voice Changer
- Sound Effects
- Audio Isolation
- Text to Voice
- Dubbing
Administration
- History
- Samples
- User
- Voices
- Voice Library
- Projects
- GETGet Projects
- GETGet Project By Id
- POSTAdd Project
- DELDelete Project
- POSTConvert Project
- GETGet Project Snapshots
- POSTStream Project Audio
- GETGet Chapters
- GETGet Chapter By Id
- POSTAdd Chapter To A Project
- DELDelete Chapter
- POSTConvert Chapter
- GETGet Chapter Snapshots
- POSTStream Chapter Audio
- POSTUpdate Pronunciation Dictionaries
- GET
- Pronunciation Dictionaries
- Models
- Audio-native
- Workspace
- Usage
Legacy
- Voice Generation (Deprecated)
Projects
Get Project By Id
Returns information about a specific project. This endpoint returns more detailed information about a project than GET api.elevenlabs.io/v1/projects.
GET
/
v1
/
projects
/
{project_id}
Copy
Ask AI
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.projects.get(
project_id="21m00Tcm4TlvDq8ikWAM",
)
Copy
Ask AI
{
"project_id": "<string>",
"name": "<string>",
"create_date_unix": 123,
"default_title_voice_id": "<string>",
"default_paragraph_voice_id": "<string>",
"default_model_id": "<string>",
"last_conversion_date_unix": 123,
"can_be_downloaded": true,
"title": "<string>",
"author": "<string>",
"description": "<string>",
"genres": [
"<string>"
],
"cover_image_url": "<string>",
"target_audience": "children",
"language": "<string>",
"content_type": "<string>",
"original_publication_date": "<string>",
"mature_content": true,
"isbn_number": "<string>",
"volume_normalization": true,
"state": "creating",
"access_level": "admin",
"fiction": "fiction",
"quality_check_on": true,
"quality_check_on_when_bulk_convert": true,
"creation_meta": {
"creation_progress": 123,
"status": "pending",
"type": "blank"
},
"quality_preset": "standard",
"chapters": [
{
"chapter_id": "<string>",
"name": "<string>",
"last_conversion_date_unix": 123,
"conversion_progress": 123,
"can_be_downloaded": true,
"state": "default",
"statistics": {
"characters_unconverted": 123,
"characters_converted": 123,
"paragraphs_converted": 123,
"paragraphs_unconverted": 123
},
"last_conversion_error": "<string>"
}
],
"pronunciation_dictionary_versions": [
{
"version_id": "<string>",
"pronunciation_dictionary_id": "<string>",
"dictionary_name": "<string>",
"version_name": "<string>",
"created_by": "<string>",
"creation_time_unix": 123
}
],
"apply_text_normalization": "auto",
"experimental": {}
}
Projects API avaliable upon request. To get access, contact sales.
Headers
Your API key. This is required by most endpoints to access our API programatically. You can view your xi-api-key using the 'Profile' tab on the website.
Path Parameters
The project_id of the project, you can query GET https://api.elevenlabs.io/v1/projects to list all available projects.
Response
200
application/json
Successful Response
The response is of type object
.
Was this page helpful?
Copy
Ask AI
from elevenlabs import ElevenLabs
client = ElevenLabs(
api_key="YOUR_API_KEY",
)
client.projects.get(
project_id="21m00Tcm4TlvDq8ikWAM",
)
Copy
Ask AI
{
"project_id": "<string>",
"name": "<string>",
"create_date_unix": 123,
"default_title_voice_id": "<string>",
"default_paragraph_voice_id": "<string>",
"default_model_id": "<string>",
"last_conversion_date_unix": 123,
"can_be_downloaded": true,
"title": "<string>",
"author": "<string>",
"description": "<string>",
"genres": [
"<string>"
],
"cover_image_url": "<string>",
"target_audience": "children",
"language": "<string>",
"content_type": "<string>",
"original_publication_date": "<string>",
"mature_content": true,
"isbn_number": "<string>",
"volume_normalization": true,
"state": "creating",
"access_level": "admin",
"fiction": "fiction",
"quality_check_on": true,
"quality_check_on_when_bulk_convert": true,
"creation_meta": {
"creation_progress": 123,
"status": "pending",
"type": "blank"
},
"quality_preset": "standard",
"chapters": [
{
"chapter_id": "<string>",
"name": "<string>",
"last_conversion_date_unix": 123,
"conversion_progress": 123,
"can_be_downloaded": true,
"state": "default",
"statistics": {
"characters_unconverted": 123,
"characters_converted": 123,
"paragraphs_converted": 123,
"paragraphs_unconverted": 123
},
"last_conversion_error": "<string>"
}
],
"pronunciation_dictionary_versions": [
{
"version_id": "<string>",
"pronunciation_dictionary_id": "<string>",
"dictionary_name": "<string>",
"version_name": "<string>",
"created_by": "<string>",
"creation_time_unix": 123
}
],
"apply_text_normalization": "auto",
"experimental": {}
}
Assistant
Responses are generated using AI and may contain mistakes.