# Shared Types
```python
from cartesia.types import PhonemeTimestamps, WordTimestamps
```
# Cartesia
Types:
```python
from cartesia.types import GetStatusResponse
```
Methods:
- client.get_status() -> GetStatusResponse
# Agents
Types:
```python
from cartesia.types import (
AgentSummary,
AgentListResponse,
AgentListPhoneNumbersResponse,
AgentListTemplatesResponse,
)
```
Methods:
- client.agents.retrieve(agent_id) -> AgentSummary
- client.agents.update(agent_id, \*\*params) -> AgentSummary
- client.agents.list() -> AgentListResponse
- client.agents.delete(agent_id) -> None
- client.agents.list_phone_numbers(agent_id) -> AgentListPhoneNumbersResponse
- client.agents.list_templates() -> AgentListTemplatesResponse
## Calls
Types:
```python
from cartesia.types.agents import AgentCall, AgentTranscript
```
Methods:
- client.agents.calls.retrieve(call_id) -> AgentCall
- client.agents.calls.list(\*\*params) -> SyncCursorIDPage[AgentCall]
- client.agents.calls.download_audio(call_id) -> None
## Metrics
Types:
```python
from cartesia.types.agents import Metric, MetricListResponse
```
Methods:
- client.agents.metrics.create(\*\*params) -> Metric
- client.agents.metrics.retrieve(metric_id) -> Metric
- client.agents.metrics.list(\*\*params) -> MetricListResponse
- client.agents.metrics.add_to_agent(metric_id, \*, agent_id) -> None
- client.agents.metrics.remove_from_agent(metric_id, \*, agent_id) -> None
### Results
Types:
```python
from cartesia.types.agents.metrics import ResultListResponse, ResultExportResponse
```
Methods:
- client.agents.metrics.results.list(\*\*params) -> SyncCursorIDPage[ResultListResponse]
- client.agents.metrics.results.export(\*\*params) -> str
## Deployments
Types:
```python
from cartesia.types.agents import Deployment, DeploymentListResponse
```
Methods:
- client.agents.deployments.retrieve(deployment_id) -> Deployment
- client.agents.deployments.list(agent_id) -> DeploymentListResponse
# AccessToken
Types:
```python
from cartesia.types import AccessTokenCreateResponse
```
Methods:
- client.access_token.create(\*\*params) -> AccessTokenCreateResponse
# Datasets
Types:
```python
from cartesia.types import Dataset
```
Methods:
- client.datasets.create(\*\*params) -> Dataset
- client.datasets.retrieve(id) -> Dataset
- client.datasets.update(id, \*\*params) -> None
- client.datasets.list(\*\*params) -> SyncCursorIDPage[Dataset]
- client.datasets.delete(id) -> None
## Files
Types:
```python
from cartesia.types.datasets import FileListResponse
```
Methods:
- client.datasets.files.list(id, \*\*params) -> SyncCursorIDPage[FileListResponse]
- client.datasets.files.delete(file_id, \*, id) -> None
- client.datasets.files.upload(id, \*\*params) -> None
# FineTunes
Types:
```python
from cartesia.types import FineTune, FineTuneBaseModel
```
Methods:
- client.fine_tunes.create(\*\*params) -> FineTune
- client.fine_tunes.retrieve(id) -> FineTune
- client.fine_tunes.list(\*\*params) -> SyncCursorIDPage[FineTune]
- client.fine_tunes.delete(id) -> None
- client.fine_tunes.list_voices(id, \*\*params) -> SyncCursorIDPage[Voice]
# PronunciationDicts
Types:
```python
from cartesia.types import PronunciationDict, PronunciationDictItem
```
Methods:
- client.pronunciation_dicts.create(\*\*params) -> PronunciationDict
- client.pronunciation_dicts.retrieve(id) -> PronunciationDict
- client.pronunciation_dicts.update(id, \*\*params) -> PronunciationDict
- client.pronunciation_dicts.list(\*\*params) -> SyncCursorIDPage[PronunciationDict]
- client.pronunciation_dicts.delete(id) -> None
# STT
Types:
```python
from cartesia.types import STTBatchModel, STTEncoding, STTErrorResponse, STTTranscribeResponse
```
Methods:
- client.stt.transcribe(\*\*params) -> STTTranscribeResponse
## AutoFinalize
Types:
```python
from cartesia.types.stt import (
STTAutoFinalizeConnected,
STTAutoFinalizeModel,
STTAutoFinalizeTurnEagerEnd,
STTAutoFinalizeTurnEnd,
STTAutoFinalizeTurnResume,
STTAutoFinalizeTurnStart,
STTAutoFinalizeTurnUpdate,
STTAutoFinalizeWebsocketRequest,
STTAutoFinalizeWebsocketResponse,
)
```
## ManualFinalize
Types:
```python
from cartesia.types.stt import (
STTManualFinalizeDoneResponse,
STTManualFinalizeFlushDoneResponse,
STTManualFinalizeModel,
STTManualFinalizeTranscriptResponse,
STTManualFinalizeWebsocketRequest,
STTManualFinalizeWebsocketResponse,
)
```
# TTS
Types:
```python
from cartesia.types import (
GenerationConfig,
GenerationRequest,
InfillModel,
ModelSpeed,
MP3OutputFormat,
OutputFormatContainer,
RawEncoding,
RawOutputFormat,
TTSModel,
TTSSSEEvent,
VoiceSpecifier,
WAVOutputFormat,
WebsocketClientEvent,
WebsocketResponse,
)
```
Methods:
- client.tts.generate(\*\*params) -> BinaryAPIResponse
- client.tts.generate_sse(\*\*params) -> TTSSSEEvent
- client.tts.infill(\*\*params) -> BinaryAPIResponse
# VoiceChanger
Types:
```python
from cartesia.types import VoiceChangerSSEEvent
```
Methods:
- client.voice_changer.generate(\*\*params) -> BinaryAPIResponse
- client.voice_changer.generate_sse(\*\*params) -> VoiceChangerSSEEvent
# Voices
Types:
```python
from cartesia.types import GenderPresentation, SupportedLanguage, Voice, VoiceMetadata
```
Methods:
- client.voices.update(id, \*\*params) -> Voice
- client.voices.list(\*\*params) -> SyncCursorIDPage[Voice]
- client.voices.delete(id) -> None
- client.voices.clone(\*\*params) -> VoiceMetadata
- client.voices.get(id, \*\*params) -> Voice
- client.voices.localize(\*\*params) -> VoiceMetadata