Widget

Get widget configuration

Changed on

Returns the current web widget configuration for the agent. Also includes assistantId (same as the agent ID) as a convenience field for the widget embed code.

get/agent/{id}/widget-config

Request

  • Base URL
    https://api.smallest.ai/atoms/v1
  • URL
    https://api.smallest.ai/atoms/v1/agent/{id}/widget-config
  • Auth
    HTTP bearer

Path parameters

idstring required

Agent ObjectId

Response

Widget configuration

successboolean

Example response

{
  "success": true
}

Changes

  • 9fd13f607823Revision changes
    • info

      api tag Widget added

    • info

      api tag Agents removed

    • info

      endpoint deprecated

  • 0eac753eb5ddRevision changes
    • breaking

      removed the media type application/json for the response with the status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id getAgentWidgetConfig was added

    • info

      added the optional property to the response with the status