---
title: "Get Embed Settings"
method: GET
path: "/api/agents/{agent_identity_id}/embed"
tags: ["agent-embed"]
---

# Get Embed Settings

`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

Read this agent's embed configuration. Owner only.

## Path parameters

- `agent_identity_id` string, uuid, required

## Headers

- `x-impersonate-identity-id` string, nullable

## Response `200`

Successful Response

- EmbedSettingsOut
  - `revision` string, required
  - `eligible` boolean, required
  - `eligibility_message` string, nullable, required
  - `app_url` string, required
  - `agent_identity_id` string, required
  - `enabled` boolean, required
  - `allowed_origins` string[], required
  - `display_name` string, nullable, required
  - `greeting` string, nullable, required
  - `starter_prompts` string[], required
  - `daily_turn_limit` integer, required
  - `visitor_turn_limit` integer, required
  - `page_awareness` 'manual' | 'text' | 'text_and_picture', required
  - `visitor_screen_share` boolean, required
  - `snippet` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/thinqos/apis/thinqos-api.md) · [All operations](https://skmtc.dev/thinqos/apis/thinqos-api/llms.txt) · [OpenAPI document](https://skmtc.dev/thinqos/apis/thinqos-api/revisions/ce2c2ce318b1?raw)