---
title: "Get deployment settings."
method: GET
path: "/api/v1/projects/{projectId}/deployment"
tags: ["Deployment Settings"]
---

# Get deployment settings.

`GET /api/v1/projects/{projectId}/deployment`

## Request

- Base URL: `https://app.customgpt.ai`
- URL: `https://app.customgpt.ai/api/v1/projects/{projectId}/deployment`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/poll-the-people/apis/customgpt-ai/docs/api/v1/projects/:projectId/deployment/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns all deployment section configurations (embed, live_chat, ai_assistant, instant_viewer, sge) for an agent. Missing settings are returned with their default values.

## Path parameters

- `projectId` integer, required

## Response `200`

Deployment settings for all sections of an agent

- object
  - `status` 'error' | 'success': The status of the response
  - `data` ProjectDeploymentSettings
    - `embed` object: Configuration for the embeddable iframe widget.
      - `width` number: Widget width value.
      - `widthUnit` 'px' | '%': Unit for width: `px` or `%`.
      - `height` number: Widget height value.
      - `heightUnit` 'px' | '%': Unit for height: `px` or `%`.
      - `heightType` 'fixed' | 'auto': Whether height is `fixed` or `auto`.
      - `resetConversation` boolean: Reset the conversation on each new session.
      - `isPrePromptEnabled` boolean: Whether the pre-prompt is enabled for this deployment.
      - `isCRMIntegrationEnabled` boolean: Whether CRM integration is enabled for this deployment.
      - `isCustomContextEnabled` boolean: Whether custom context injection is enabled.
      - `isLabelsFilterEnabled` boolean: Filter responses by source labels (requires plan with source labeling).
      - `labelsExclusive` boolean: When label filtering is active, use exclusive (AND) matching.
      - `mobileFontSize` boolean: Use mobile-optimised font sizing.
      - `delayIframeLoadMs` number: Milliseconds to delay iframe load.
    - `live_chat` object: Configuration for the live-chat bubble widget.
      - `width` number: Widget width value.
      - `widthUnit` 'px' | '%': Unit for width: `px` or `%`.
      - `height` number: Widget height value.
      - `heightUnit` 'px' | '%': Unit for height: `px` or `%`.
      - `heightType` 'fixed' | 'auto': Whether height is `fixed` or `auto`.
      - `resetConversation` boolean: Reset the conversation on each new session.
      - `isPrePromptEnabled` boolean: Whether the pre-prompt is enabled for this deployment.
      - `isCRMIntegrationEnabled` boolean: Whether CRM integration is enabled for this deployment.
      - `isCustomContextEnabled` boolean: Whether custom context injection is enabled.
      - `isLabelsFilterEnabled` boolean: Filter responses by source labels (requires plan with source labeling).
      - `labelsExclusive` boolean: When label filtering is active, use exclusive (AND) matching.
      - `mobileFontSize` boolean: Use mobile-optimised font sizing.
      - `autoPopUp` integer: Seconds before the chat bubble auto-pops open (0 = disabled).
      - `position` 'left' | 'right': Screen position of the bubble: `left` or `right`.
      - `chatbotType` 'window' | 'compact' | 'floating': Visual style of the chat bubble.
      - `iconSize` 'small' | 'medium' | 'large': Icon size for the chat bubble trigger.
      - `autoPromptStarterQuestion` boolean: Automatically prompt the first starter question.
      - `doNotPromptOnMobile` boolean: Suppress auto-prompts on mobile devices.
      - `autoStartConversation` boolean: Automatically start a new conversation when the widget opens.
      - `hidePromptFromStarterQuestionList` boolean: Hide the pre-prompt from the starter question list.
      - `continueConversation` boolean: Persist and continue the previous conversation.
    - `ai_assistant` object: Configuration for the AI Assistant button widget.
      - `resetConversation` boolean: Reset the conversation on each new session.
      - `isPrePromptEnabled` boolean: Whether the pre-prompt is enabled for this deployment.
      - `isCRMIntegrationEnabled` boolean: Whether CRM integration is enabled for this deployment.
      - `isCustomContextEnabled` boolean: Whether custom context injection is enabled.
      - `isLabelsFilterEnabled` boolean: Filter responses by source labels (requires plan with source labeling).
      - `labelsExclusive` boolean: When label filtering is active, use exclusive (AND) matching.
      - `mobileFontSize` boolean: Use mobile-optimised font sizing.
      - `defaultButtonText` string: Label text on the default trigger button.
      - `defaultButtonColor` string: Hex colour for the default trigger button.
      - `isUsingDefaultButton` boolean: Whether to show the default styled button.
      - `isUsingCustomElement` boolean: Whether a custom HTML element is used as the trigger.
      - `chatbotType` 'window' | 'compact' | 'floating': Visual style of the assistant panel.
    - `instant_viewer` object: Configuration for the Instant Viewer (legacy PDF chat) widget.
      - `resetConversation` boolean: Reset the conversation on each new session.
      - `isPrePromptEnabled` boolean: Whether the pre-prompt is enabled for this deployment.
      - `isCRMIntegrationEnabled` boolean: Whether CRM integration is enabled for this deployment.
      - `isCustomContextEnabled` boolean: Whether custom context injection is enabled.
      - `isLabelsFilterEnabled` boolean: Filter responses by source labels (requires plan with source labeling).
      - `labelsExclusive` boolean: When label filtering is active, use exclusive (AND) matching.
      - `mobileFontSize` boolean: Use mobile-optimised font sizing.
      - `defaultButtonText` string: Label text on the trigger button.
      - `defaultButtonColor` string: Hex colour for the trigger button.
      - `isUsingDefaultButton` boolean: Whether to show the default styled button.
      - `isUsingCustomElement` boolean: Whether a custom HTML element is used as the trigger.
      - `chatbotType` 'window' | 'compact' | 'floating': Visual style of the viewer panel.
    - `sge` object: Configuration for the Search Generative Experience (SGE) widget.
      - `resetConversation` boolean: Reset the conversation on each new session.
      - `isPrePromptEnabled` boolean: Whether the pre-prompt is enabled for this deployment.
      - `isCRMIntegrationEnabled` boolean: Whether CRM integration is enabled for this deployment.
      - `isCustomContextEnabled` boolean: Whether custom context injection is enabled.
      - `isLabelsFilterEnabled` boolean: Filter responses by source labels (requires plan with source labeling).
      - `labelsExclusive` boolean: When label filtering is active, use exclusive (AND) matching.
      - `mobileFontSize` boolean: Use mobile-optimised font sizing.
      - `height` number: Widget height in pixels.
      - `heightUnit` 'px' | '%': Unit for height.
      - `heightType` 'fixed' | 'auto': Whether height is fixed or auto.
      - `customSearchParameter` string: URL query parameter name to pass as the search query (alphanumeric, dash, underscore; max 15 chars).
      - `delayIframeLoadMs` number: Milliseconds to delay iframe load.

## Other responses

- `401`: API Token is either missing or invalid
- `404`: Agent not found
- `500`: Internal Server Error

## Changes

- **2026-11-03** `77aab4354382`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/poll-the-people/apis/customgpt-ai/changes/api/v1/projects/:projectId/deployment/get.md)

---

[API](https://skmtc.dev/poll-the-people/apis/customgpt-ai.md) - [All operations](https://skmtc.dev/poll-the-people/apis/customgpt-ai/llms.txt) - [OpenAPI document](https://skmtc.dev/poll-the-people/apis/customgpt-ai/revisions/77aab4354382?raw)