agent-embed

Get Embed Settings

Read this agent's embed configuration. Owner only.

get/api/agents/{agent_identity_id}/embed

Request

  • Base URL: https://app.thinqos.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.thinqos.com/api/agents/{agent_identity_id}/embed
  • Auth: none declared

Path parameters

agent_identity_idstring uuid required

Headers

x-impersonate-identity-idstring nullable

Response

Successful Response

revisionstring required
eligibleboolean required
eligibility_messagestring nullable required
app_urlstring required
agent_identity_idstring required
enabledboolean required
allowed_originsstring[] required
display_namestring nullable required
greetingstring nullable required
starter_promptsstring[] required
daily_turn_limitinteger required
visitor_turn_limitinteger required
page_awareness'manual' | 'text' | 'text_and_picture' required
visitor_screen_shareboolean required
snippetstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.