Sign in

v1

latestOpenAPI 3.0.32026-07-24106305257.4 KB
Agentic Videos

Update an agentic video

Update an agentic video. Top-level fields update the video itself; the optional agent object is applied to the linked agent, so a single request can save both. Only the fields you include are changed. Returns the updated video and its agent.

patch/agentic-videos/{id}

Path parameters

idstring required

Request body

namestring

Display name of the agentic video.

show_agent_on_video_endboolean

Whether the agent automatically appears when the video finishes playing.

bubble_textstring

Text shown in the call-to-action bubble that invites viewers to start chatting.

Example request

{
  "name": "Product walkthrough"
}

Response

Agentic video updated

Example response

{
  "video": {
    "video_id": "avd_a1b2c3d4e5",
    "name": "Product walkthrough",
    "video_url": "https://agentic-videos-results.d-id.com/owner-123/avd_a1b2c3d4e5/video.mp4",
    "thumbnail_url": "https://agentic-videos-results.d-id.com/owner-123/avd_a1b2c3d4e5/thumbnail.jpg",
    "duration": 42,
    "language": "en-US",
    "agent_id": "agt_a1b2c3d4e5",
    "background": {
      "color": "#47ffff",
      "source_url": "https://path.to.image/"
    },
    "bubble_text": "Ask me anything",
    "created_by": "user-123",
    "created_at": "2024-01-01T00:00:00.000Z",
    "modified_at": "2024-01-01T00:00:00.000Z"
  },
  "agent": {
    "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"
    }
  }
}