Projects
Get Projects
- Documentation
- API Reference
- Python Library
- Community
- Getting Started
- How to use text to speech
- Combining multiple generations
- How to use pronunciation dictionaries
- How to use the text to sound effects API
- How to dub a video
- Integrating with Twilio
- Reducing Latency
- How to use websocket
- POSTText To Speech
- POSTText To Speech With Timestamps
- POSTStreaming
- POSTText To Speech Streaming With Timestamps
- Websockets
- POSTSound Generation
- GETGet Generated Items
- GETGet History Item By Id
- DELDelete History Item
- GETGet Audio From History Item
- POSTDownload History Items
- GETGet Voices
- GETGet Default Voice Settings.
- GETGet Voice Settings
- GETGet Voice
- DELDelete Voice
- POSTEdit Voice Settings
- POSTAdd Voice
- POSTEdit Voice
- GETGet Projects
- GETGet Project By Id
- POSTAdd Project
- DELDelete Project
- POSTConvert Project
- GETGet Project Snapshots
- POSTStream Project Audio
- GETGet Chapters
- GETGet Chapter By Id
- DELDelete Chapter
- POSTConvert Chapter
- GETGet Chapter Snapshots
- POSTStream Chapter Audio
- POSTUpdate Pronunciation Dictionaries
- POSTAdd from file
- GETGet dictionaries
- GETGet dictionary by id
- POSTAdd rules
- POSTRemove rules
- GETDownload version by id
- GETGet Models
- POSTCreates Audionative Enabled Project.
Guides
Text to Speech
Sound Effects
History
Voices
Projects
Pronunciation Dictionaries
Models
Audio-native
Projects
Get Projects
Returns a list of your projects together and its metadata.
GET
/
v1
/
projects
xi-api-key
Xi-Api-Key · string
xi-api-key
string
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.
Projects API avaliable upon request. To get access, contact sales.
Headers
xi-api-key
string
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.
Response
200 - application/json
projects
object[]
requiredprojects.project_id
string
requiredprojects.name
string
requiredprojects.create_date_unix
integer
requiredprojects.default_title_voice_id
string
requiredprojects.default_paragraph_voice_id
string
requiredprojects.default_model_id
string
requiredprojects.last_conversion_date_unix
integer
requiredprojects.can_be_downloaded
boolean
requiredprojects.title
string
requiredprojects.author
string
requiredprojects.isbn_number
string
requiredprojects.volume_normalization
boolean
requiredprojects.state
enum<string>
requiredAvailable options:
default
, converting
, in_queue