# D-ID Documentation

## Guides
- [API Keys](https://docs.d-id.com/docs/api-keys.md): Get your API key from the Studio in four steps
- [Quickstart](https://docs.d-id.com/docs/quickstart.md): Get started with D-ID's APIs
- [Client Tools](https://docs.d-id.com/docs/elevenlabs-agent-client-tools.md): Run browser-side tools when an ElevenLabs-backed agent calls a function
- [Overview](https://docs.d-id.com/docs/elevenlabs-agent-overview.md): Create an agent that delegates the conversation pipeline to ElevenLabs and renders a D-ID avatar
- [Quickstart](https://docs.d-id.com/docs/elevenlabs-agent-quickstart.md): Create an ElevenLabs-backed agent and connect to it in four steps
- [Vision](https://docs.d-id.com/docs/elevenlabs-agent-vision.md): Give an ElevenLabs-backed agent live camera awareness
- [Control the Agent](https://docs.d-id.com/docs/livekit-commands.md): Send speak, chat, and interrupt commands over the LiveKit data channel
- [Listen for Agent Events](https://docs.d-id.com/docs/livekit-events.md): Handle video, chat, and tool events sent by the agent over the data channel
- [Subscribe to Media Tracks](https://docs.d-id.com/docs/livekit-media-tracks.md): Render the agent's video and audio in your app
- [Overview](https://docs.d-id.com/docs/livekit-overview.md): How Agents Streams V2 works and how to choose an integration path
- [Quickstart](https://docs.d-id.com/docs/livekit-quickstart.md): Connect to an Expressive Agent with the LiveKit SDK in six steps
- [MCP](https://docs.d-id.com/docs/mcp.md)
- [Agents](https://docs.d-id.com/docs/agent-quickstart.md): Create an AI agent with a digital avatar
- [Agent Sessions](https://docs.d-id.com/docs/agent-session-quickstart.md): Stream real-time conversations with your agent
- [Chat Exports](https://docs.d-id.com/docs/chat-exports-quickstart.md): Export your agent's conversation history
- [Knowledge](https://docs.d-id.com/docs/knowledge-quickstart.md): Create a knowledge base for your agent
- [Custom LLMs](https://docs.d-id.com/docs/custom-llms.md): How to implement and integrate custom LLMs in agents (advance integration)
- [Overview](https://docs.d-id.com/docs/llms-overview.md): Choose the right LLM for your AI agent
- [Quickstart](https://docs.d-id.com/docs/llms-quickstart.md): Create an agent with a custom LLM in 3 minutes
- [Overview](https://docs.d-id.com/docs/realtime-overview.md): How Realtime agents work and how to deploy them
- [Amazon Polly](https://docs.d-id.com/docs/tts-amazon.md): Unrecommended for most use-cases
- [ElevenLabs](https://docs.d-id.com/docs/tts-elevenlabs.md): Premium TTS provider
- [Microsoft Speech](https://docs.d-id.com/docs/tts-microsoft.md): The default TTS provider
- [Appearance and Attributes](https://docs.d-id.com/docs/embed-attributes.md): HTML attribute configuration reference for the embed script
- [Events and States](https://docs.d-id.com/docs/embed-events.md): Event subscription and state monitoring for embedded agents
- [Controls and Methods](https://docs.d-id.com/docs/embed-methods.md): Programmatic control functions and runtime configuration
- [Overview](https://docs.d-id.com/docs/embed-overview.md): Add an AI agent to your website with a single script tag
- [Quickstart](https://docs.d-id.com/docs/embed-quickstart.md): Add an AI agent to your website in 5 minutes with a single script tag
- [Quickstart](https://docs.d-id.com/docs/v2-photo-avatar-quickstart.md): Create talking head videos from a photo and text
- [Quickstart](https://docs.d-id.com/docs/v3-instant-avatar-quickstart.md): Create a custom avatar from your own video footage
- [Quickstart](https://docs.d-id.com/docs/v3-pro-avatar-quickstart.md): Create Full-HD videos with high quality avatars
- [Quickstart](https://docs.d-id.com/docs/v4-expressive-avatar-quickstart.md): Create expressive videos with V4 Avatars using different emotional states (sentiments)
- [Video Translate](https://docs.d-id.com/docs/video-translate-quickstart.md): Translate and lip-sync any video to new languages

## API Reference
- [API Keys](https://docs.d-id.com/reference/basic-authentication.md)
- [Agents SDK Overview](https://docs.d-id.com/reference/agents-sdk-overview.md)
- [Create a new session](https://docs.d-id.com/reference/createsession.md): Creates a new streaming session for an Expressive Agent and returns the credentials needed to connect to the room.
- [Get session detail](https://docs.d-id.com/reference/getsession.md): Get full detail for a single session, including the session summary, AI-generated insights (headline, outcome, summary, detected issues), and V2 telemetry (bandwidth, quality samples, publish bps/fps, participant info).
- [List sessions](https://docs.d-id.com/reference/listsessions.md): List the user's sessions, with optional agent and time-range filters.
- [Submit network information](https://docs.d-id.com/reference/addicecandidateagent.md): Updates the server with a WebRTC ICE candidate. If the candidate parameter is missing or a value of null is given the added ICE candidate is an "end-of-candidates" indicator.
- [Send a message to a Chat](https://docs.d-id.com/reference/agentchat.md): Send a chat message to the existing chat with the agent
- [Create a new stream](https://docs.d-id.com/reference/createagentstream.md): Initiates the creation of a new WebRTC connection to a browser peer. The endpoint returns the necessary information to set up and manage the connection.
- [Create a Chat](https://docs.d-id.com/reference/createchat.md): Create a new chat with the agent. Each chat has separated history
- [Create a video stream](https://docs.d-id.com/reference/createvideoagentstream.md)
- [Delete a video stream](https://docs.d-id.com/reference/deleteagentstream.md)
- [Start a WebRTC connection](https://docs.d-id.com/reference/startagentconnection.md): Updates the server with the SDP answer to the SDP offer received from the initial call to the `/agents/{agentId}/streams` endpoint, during the offer/answer negotiation of a WebRTC connection.
- [Create an Agent](https://docs.d-id.com/reference/createagent.md): Creates a new Agent.
- [Delete an Agent](https://docs.d-id.com/reference/deleteagent.md): Deletes an existing Agent.
- [Get an Agent](https://docs.d-id.com/reference/getagent.md): Returns details for a specific Agent.
- [List Agents](https://docs.d-id.com/reference/listmyagents.md): Returns a list of all Agents.
- [Update an Agent](https://docs.d-id.com/reference/updateagent.md): Updates an existing Agent.
- [Create a new Client Key](https://docs.d-id.com/reference/createclientkey.md)
- [Create Agent Client Key](https://docs.d-id.com/reference/createresourceclientkey.md): Create a client key scoped to a specific agent. Multiple keys per agent are allowed with different domain sets.
- [Delete Agent Client Key](https://docs.d-id.com/reference/deleteresourceclientkey.md): Delete a client key scoped to a specific agent
- [Get Client Key](https://docs.d-id.com/reference/getclientkey.md)
- [List Agent Client Keys](https://docs.d-id.com/reference/listresourceclientkeys.md): List all client keys scoped to a specific agent
- [Update Client Key](https://docs.d-id.com/reference/updateclientkey.md)
- [Update Agent Client Key](https://docs.d-id.com/reference/updateresourceclientkey.md): Update a client key scoped to a specific agent
- [Create chat logs](https://docs.d-id.com/reference/create-chat-logs.md): Create a chat log export for `agent_id` containing all of the Agent's chats.  Use the `export_id` in the GET chat logs endpoint to get the result of the create chat logs request (zipped JSON files).  (The chat log export will be deleted from the database after 7 days from the export creation date)
- [Get chat logs](https://docs.d-id.com/reference/get-chat-logs.md)
- [Create ElevenLabs agent](https://docs.d-id.com/reference/createelevenlabsagent.md): Create an ElevenLabs-backed agent. Requires a pre-created secret containing the ElevenLabs API key.
- [Update ElevenLabs agent](https://docs.d-id.com/reference/updateelevenlabsagent.md): Update an ElevenLabs-backed agent. Only agents created via the ElevenLabs integration endpoint can be updated here.
- [Create a Document](https://docs.d-id.com/reference/createdocument.md): Add document to knowledge base Here you could add any document of supported type to become knowledge for your agent. Agent will use this documents to answer for user questions.
- [Create a Knowledge](https://docs.d-id.com/reference/createknowledge.md): Knowledge used to provide information for agent, that search by this info and return in chat with user. Each Knowledge could store up to 5 documents
- [Delete a Document](https://docs.d-id.com/reference/deletedocument.md): Delete document from knowledge base
- [Delete a Knowledge](https://docs.d-id.com/reference/deleteknowledge.md): Knowledge will be deleted with all documents in it. Knowledge that was deleted will no longer be available for any agent.
- [Get a Document](https://docs.d-id.com/reference/getdocument.md): Get document by id from knowledge base
- [Get Documents](https://docs.d-id.com/reference/getdocuments.md): Get all documents from knowledge base
- [Get a Knowledge](https://docs.d-id.com/reference/getknowledge.md): Get specific knowledge base
- [Get Knowledges](https://docs.d-id.com/reference/getknowledges.md): Get all user knowledge bases
- [Update a Knowledge](https://docs.d-id.com/reference/updateknowledge.md): If you need to change some of knowledge field
- [Create a rating](https://docs.d-id.com/reference/createrating.md): Create a new rating of agent message for specific chat
- [Delete a rating](https://docs.d-id.com/reference/deleterating.md): Delete a specific rating of agent chat message
- [Update a rating](https://docs.d-id.com/reference/updaterating.md): Update a specific rating of agent message
- [Create a new tool](https://docs.d-id.com/reference/createtool.md): Create a new tool
- [Delete a tool](https://docs.d-id.com/reference/deletetool.md): Delete a tool
- [Get a tool](https://docs.d-id.com/reference/gettool.md): Get a tool by ID
- [Get tools by IDs](https://docs.d-id.com/reference/gettoolsbyids.md): Get multiple tools by IDs
- [List tools](https://docs.d-id.com/reference/listtools.md): List tools for the authenticated user
- [Update a tool](https://docs.d-id.com/reference/updatetool.md): Update a tool
- [Delete an audio file](https://docs.d-id.com/reference/deleteaudio.md)
- [Upload audio file](https://docs.d-id.com/reference/upload-an-audio.md): Upload an audio file to a temporary storage before creating an animation. The audio is uploaded using multipart/form-data. the filename directive is optional and if provided should contain up to 50 valid characters long. The resulting file is stored as a .wav file in a 16kHz sample rate. Valid characters: a-z A-Z 0-9 . _ - Supported mime types: "audio/, video/" Storage duration: 24-48H
- [Create a consent](https://docs.d-id.com/reference/create.md)
- [Delete a consent by id](https://docs.d-id.com/reference/delete1.md)
- [Get a consent by id](https://docs.d-id.com/reference/get.md)
- [list all consents for the user](https://docs.d-id.com/reference/list.md)
- [Upload video for consent](https://docs.d-id.com/reference/uploadvideo.md)
- [Get credits](https://docs.d-id.com/reference/getcredits.md): Get the user's credits items each credit item contains the remaining and total credits for the user With the time expiration of the credits
- [Delete image](https://docs.d-id.com/reference/deleteimage.md)
- [Upload image](https://docs.d-id.com/reference/upload-an-image.md): Upload an image to a temporary storage before creating an animation. The image is uploaded using multipart/form-data. the filename directive is optional and if provided should contain up to 50 valid characters long. Valid characters: a-z A-Z 0-9 . _ - Supported mime types: image/jpeg,image/png Storage duration: 24-48H
- [Create a Secret](https://docs.d-id.com/reference/createsecret.md)
- [Delete a Secret](https://docs.d-id.com/reference/deletesecret.md): Delete a secret by its ID. This action is permanent and cannot be undone.
- [List Secrets](https://docs.d-id.com/reference/getallsecrets.md): Retrieve all secrets for the authenticated user. Returns a list of secrets with sanitized (masked) secret values.
- [Get Secret by ID](https://docs.d-id.com/reference/getsecretbyid.md): Retrieve a specific secret by its ID. Returns the secret with a sanitized (masked) secret value.
- [Update a Secret](https://docs.d-id.com/reference/updatesecret.md): Update an existing secret.
- [Delete logo](https://docs.d-id.com/reference/deletelogo.md)
- [Get logo](https://docs.d-id.com/reference/getlogo.md)
- [Upload logo](https://docs.d-id.com/reference/uploadlogo.md)
- [Clone Voice](https://docs.d-id.com/reference/clonevoice.md): Add a new voice to your collection of voices. Upload audio or video file to clone the voice from. For optimal voice cloning results, you should provide at least 30 seconds of diverse high-quality audio samples.
- [Delete Voice](https://docs.d-id.com/reference/deletevoice.md): Delete clone voice based on voice id
- [Get Voices](https://docs.d-id.com/reference/voices.md)
- [Create a clip](https://docs.d-id.com/reference/createclip.md)
- [Delete a specific clip](https://docs.d-id.com/reference/deleteclip.md)
- [Delete a presenter by its id](https://docs.d-id.com/reference/deletepresenter.md)
- [Get a specific clip](https://docs.d-id.com/reference/getclip.md)
- [Get clips](https://docs.d-id.com/reference/getclips.md)
- [Get presenter by id](https://docs.d-id.com/reference/getpresenterbyid.md)
- [Get a list of the presenters](https://docs.d-id.com/reference/getpresenters.md)
- [Create a Premium+ Avatar](https://docs.d-id.com/reference/trainclip.md)
- [Create an Express Avatar](https://docs.d-id.com/reference/create-express-avatar.md)
- [Create a Scene](https://docs.d-id.com/reference/create-scene.md)
- [Delete an avatar by id](https://docs.d-id.com/reference/delete-express-avatar.md)
- [Delete a specific scene](https://docs.d-id.com/reference/delete-scene.md)
- [Get an avatar by id](https://docs.d-id.com/reference/get-express-by-id.md)
- [Get a specific scene](https://docs.d-id.com/reference/get-scene-by-id.md)
- [Get a list of the avatars](https://docs.d-id.com/reference/getavatars.md)
- [Get a list of the scenes](https://docs.d-id.com/reference/getscenes.md)
- [Create a talk](https://docs.d-id.com/reference/createtalk.md)
- [Delete a specific talk](https://docs.d-id.com/reference/deletetalk.md)
- [Get a specific talk](https://docs.d-id.com/reference/gettalk.md)
- [Get talks](https://docs.d-id.com/reference/gettalks.md)
- [Create a Video](https://docs.d-id.com/reference/createv4video.md)
- [Delete Video by ID](https://docs.d-id.com/reference/deletev4video.md)
- [Get avatar by id](https://docs.d-id.com/reference/getv4avatarbyid.md)
- [Get Video by ID](https://docs.d-id.com/reference/getv4video.md)
- [List all of the expressive avatars](https://docs.d-id.com/reference/listv4avatars.md)
- [List Videos](https://docs.d-id.com/reference/listv4videos.md)
- [Create a Video Translate](https://docs.d-id.com/reference/createvideotranslate.md)
- [Delete a specific Video Translate](https://docs.d-id.com/reference/deletevideotranslate.md)
- [Get a specific Video Translate](https://docs.d-id.com/reference/getvideotranslate.md)
- [Get Video Translates](https://docs.d-id.com/reference/getvideotranslates.md)
- [Getting Started](https://docs.d-id.com/reference/get-started.md): Explore the different API capabilities

## Pages
- [D-ID's upcoming SDK 🚀](https://docs.d-id.com/sdk.md)