Agents Platform

Post Agent Avatar

Changed on

Sets the avatar for an agent displayed in the widget

post/v1/convai/agents/{agent_id}/avatar

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/convai/agents/{agent_id}/avatar
  • Auth
    none declared

Path parameters

agent_idstring required

The id of an agent. This is returned on agent creation.

Example:agent_3701k3ttaq12ewp8b7qv5rfyszkz

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

Request body multipart/form-data

avatar_filestring binary required

An image file to be used as the agent's avatar.

Response

Successful Response

agent_idstring required
avatar_urlstring nullable

Changes

  • 5b595807512cRevision changes
    • info

      api operation id Post_Agent_avatar_v1_convai_agents__agent_id__avatar_post removed and replaced with post_agent_avatar_route

    • info

      api tag Agents Platform added

    • info

      api tag Conversational AI removed

  • 503db4198a44Revision changes
    • breaking

      response property avatar_url list-of-types was widened by adding types null to media type application/json of response 200

    • info

      header request parameter xi-api-key list-of-types was widened by adding types null

    • info

      for the header request parameter xi-api-key, the type was generalized from string to no type