Sign in

v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB
Agents

Update an Agent

Updates an existing Agent.

patch/agents/{id}

Path parameters

idstring required

Agent Id

Headers

x-api-key-externalstring

Use your own ElevenLabs API key for TTS (IVC voices only), consuming your ElevenLabs quota. Example: {"elevenlabs": "ABCDEFGH123456"}

Request body

preview_namestring

Agent name

preview_descriptionstring

Description of the agent

starter_messagestring[]

List of suggested questions shown to the user at the start of the chat.

greetingsstring[]

Greeting messages used when the chat starts. One greeting is selected at random.

user_datastring
embedboolean

Enables the Agent for use with the SDK or website embedding via D-ID Studio.

Example request

{
  "presenter": {
    "voice": {
      "voice_id": "en-US-JennyNeural",
      "voice_config": {
        "rate": "0.5",
        "pitch": "+2st"
      },
      "language": "English (United States)"
    }
  },
  "llm": {
    "prompt_customization": {
      "role": "Salesperson",
      "topics_to_avoid": [
        "Politics",
        "Religion"
      ],
      "max_response_length": 75
    }
  },
  "triggers": {
    "chat/end": {
      "webhooks": [
        {
          "url": "https://example.com"
        }
      ]
    }
  },
  "pronunciation_dictionary": {
    "id": "dict_V1StGXR8_Z5jdHi6B-myT"
  }
}

Response

OK

idstring required

Id of agent

preview_descriptionstring

Description of the agent

provider'd-id-agents'

The provider of the agent

starter_messagestring[]

List of messages to be showen as chat starter questions for the user to ask

greetingsstring[]

Greeting messages for the agent One greeting is randomly displayed at the start of the chat

client_keystring

Auto-generated scoped client key for the agent

embedboolean required

Example response

{
  "presenter": {
    "voice": {
      "voice_id": "en-US-JennyNeural",
      "voice_config": {
        "rate": "0.5",
        "pitch": "+2st"
      },
      "language": "English (United States)"
    }
  },
  "llm": {
    "prompt_customization": {
      "role": "Salesperson",
      "topics_to_avoid": [
        "Politics",
        "Religion"
      ],
      "max_response_length": 75
    }
  },
  "triggers": {
    "chat/end": {
      "webhooks": [
        {
          "url": "https://example.com"
        }
      ]
    }
  },
  "pronunciation_dictionary": {
    "id": "dict_V1StGXR8_Z5jdHi6B-myT"
  }
}