API Reference

Generate Embed Url

post
https://api.alcmeon.com/embed

Generate a temporarily valid url for an Alcmeon conversation. This url is expected to be associated with an iframe hosted on the domain configured with the application calling this endpoint. DO NOT STORE the returned url in permanent storage.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
embed_id
required
string

A username intended to replace the email when we wish to display a name for an Agent. If unspecified, the email will be used instead.

string
required

The email of the user who wants to access the embed url. If there is no account matching this email, a new account is automatically created with this email.

string
enum
required

Specifies the format and layout of the widget displayed within the iframe.

Allowed:
string
enum
required

The user account associated with the email will be granted these permissions before generating the url.

Allowed:
Responses

Updated 10 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 months ago

Did this page help you?