Agent

Retrieve a chat button and its HTML

Requires the agent:read scope.

get/chat_buttons/{id}

Request

  • Base URL: https://api.meetdarwin.ai/v1
  • URL: https://api.meetdarwin.ai/v1/chat_buttons/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

OK

idstring required
object'chat_button' required
labelstring required
messagestring required
behavior'send' | 'fill' | 'agent' | 'outcome' required
style'brand' | 'soft' | 'outline' | 'link' required
size'sm' | 'md' | 'lg' | 'custom' required
corners'match' | 'square' | 'pill' | 'custom' required
width'auto' | 'full' required
nofollowboolean required
linkstring required
htmlstring required

The paste-in HTML: a plain link that opens the chat already on the page.

Example response

{
  "id": "btn_k3j9x2m4p7"
}

Changes

No recorded changes to this operation across all 1 revision of this API.