Agent Settings

Get agent settings.

Changed on Nov 3, 2026

Returns the complete configuration for an agent, including persona instructions, response behavior, deployment options, and feature flags. Use this to review or back up an agent's configuration.

get/api/v1/projects/{projectId}/settings

Request

Base URL
https://app.customgpt.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/poll-the-people/apis/customgpt-ai/docs/api/v1/projects/:projectId/settings/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

Response

Agent settings that belong to a certain agent

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "chatbot_avatar": "https://example.com/agent_avatar.png",
    "chatbot_background_type": "color",
    "radius_styling": "soft",
    "font_family": "inter",
    "chatbot_background": "https://example.com/agent_background.png",
    "chatbot_background_color": "#FFFFFF",
    "chatbot_color_scheme": "fresh",
    "default_prompt": "How can I help you?",
    "example_questions": [
      "How do I get started?"
    ],
    "response_source": "own_content",
    "chatbot_msg_lang": "en",
    "chatbot_color": "#000000",
    "chatbot_toolbar_color": "#000000",
    "persona_instructions": "You are a custom agent assistant called CustomGPT.ai, a friendly lawyer who answers questions based on the given context.",
    "citations_answer_source_label_msg": "Sources referenced in this response",
    "citations_sources_label_msg": "Sources",
    "hang_in_there_msg": "Hang in there! I'm thinking..",
    "chatbot_siesta_msg": "Oops! The agent is taking a siesta. We are aware of this and will get it back soon! Please try again later.",
    "chatbot_failed_moderation_msg": "Sorry, I can't assist with that request. Please ask another question or let me know how I can help in a different way.",
    "account_out_of_queries_msg": "I've been answering so many questions, I've got to take a little break for a bit.",
    "is_loading_indicator_enabled": 2,
    "live_activity_msg": "Thinking...",
    "enable_citations": 3,
    "enable_feedbacks": true,
    "enable_copy_button": true,
    "citations_view_type": "user",
    "image_citation_display": "default",
    "no_answer_message": "Sorry, I don't have an answer for that.",
    "ending_message": "Please email us for further support",
    "try_asking_questions_msg": "Try asking these questions...",
    "view_more_msg": "View more",
    "view_less_msg": "View less",
    "branding_text": "Sponsored by <b>Acme</b>",
    "branding_url": "https://example.com",
    "branding_logo": "https://example.com/sponsor_logo.png",
    "chatbot_model": "gpt-4-1",
    "hide_sources_from_responses": true,
    "user_avatar": "avatar.png",
    "title_avatar_enabled": true,
    "spotlight_avatar": "spotlight_avatar.png",
    "spotlight_avatar_shape": "rectangle",
    "spotlight_avatar_type": "default",
    "user_avatar_orientation": "agent-left-user-right",
    "agent_title_avatar_alignment": "center",
    "conversation_retention_period": "year",
    "conversation_retention_days": 180,
    "enable_agent_knowledge_base_awareness": true,
    "markdown_enabled": true,
    "enable_full_file_read": true,
    "user_awareness": true,
    "context_depth": "compact",
    "master_project_smart_routing_mode": "start-only",
    "master_project_user_agent_switching_enabled": true,
    "max_actions_per_query": 5,
    "is_in_chat_agent_avatar_enabled": true,
    "is_in_chat_user_avatar_enabled": true,
    "conversation_history": "hidden",
    "end_user_login_button": "dynamic",
    "is_pdf_viewer_autoopen": true,
    "pdf_limited_page_label": "Limited",
    "allowed_domains_for_embedding": [
      "example.com",
      "app.example.com"
    ]
  }
}

Changes

Nov 3, 202677aab4354382 Revision changes
- breaking
  the / response property's maxLength was increased from 30 to 200 for the response status
- breaking
  the / response's property type changed from boolean to integer for status
- breaking
  the / response's property type changed from boolean to integer for status
- breaking
  the / response's property type changed from boolean to integer for status
- warning
  added the new 0.00 enum value to the / response property for the response status
- warning
  added the new 0.00 enum value to the / response property for the response status
- warning
  added the new 0.00 enum value to the / response property for the response status
- warning
  added the new 1.00 enum value to the / response property for the response status
- warning
  added the new 1.00 enum value to the / response property for the response status
- warning
  added the new 1.00 enum value to the / response property for the response status
- warning
  added the new 2.00 enum value to the / response property for the response status
- warning
  added the new 2.00 enum value to the / response property for the response status
- warning
  added the new 2.00 enum value to the / response property for the response status
- warning
  added the new 422.00 enum value to the / response property for the response status
- warning
  added the new 422.00 enum value to the / response property for the response status
- warning
  added the new 422.00 enum value to the / response property for the response status
- warning
  added the new 422.00 enum value to the / response property for the response status
- warning
  added the new claude-4.5-haiku enum value to the / response property for the response status
- warning
  added the new claude-4.5-opus enum value to the / response property for the response status
- warning
  added the new claude-4.5-sonnet enum value to the / response property for the response status
- warning
  added the new claude-4.6-opus enum value to the / response property for the response status
- warning
  added the new claude-4.6-sonnet enum value to the / response property for the response status
- warning
  added the new claude-4.6-sonnet-thinking enum value to the / response property for the response status
- warning
  added the new claude-4.8-opus enum value to the / response property for the response status
- warning
  added the new claude-5-opus enum value to the / response property for the response status
- warning
  added the new claude-5-sonnet enum value to the / response property for the response status
- warning
  added the new claude-5-sonnet-thinking enum value to the / response property for the response status
- warning
  added the new claude-5.5-opus enum value to the / response property for the response status
- warning
  added the new color enum value to the / response property for the response status
- warning
  added the new gemini-3-pro enum value to the / response property for the response status
- warning
  added the new gemini-3.1-pro enum value to the / response property for the response status
- warning
  added the new gemini-3.5-flash enum value to the / response property for the response status
- warning
  added the new gpt-5.1-low enum value to the / response property for the response status
- warning
  added the new gpt-5.1-none enum value to the / response property for the response status
- warning
  added the new gpt-5.2-low enum value to the / response property for the response status
- warning
  added the new gpt-5.2-none enum value to the / response property for the response status
- warning
  added the new gpt-5.4-low enum value to the / response property for the response status
- warning
  added the new gpt-5.6-luna-none enum value to the / response property for the response status
- warning
  added the new gpt-5.6-sol-none enum value to the / response property for the response status
- warning
  added the new gpt-5.6-terra-none enum value to the / response property for the response status
- warning
  added the new gpt-6-luna-none enum value to the / response property for the response status
- warning
  added the new gpt-6-sol-none enum value to the / response property for the response status
- warning
  added the new image enum value to the / response property for the response status
- info
  added the non-success response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  the response's property default value changed from #F5F5F5 to #FFFFFF for the status
- info
  the response's property default value changed from image to color for the status
- info
  the response's property default value changed from gpt-4-o to gpt-4-1 for the status
- info
  the response's property default value changed from #000000 to #565656 for the status
- info
  the response's property default value changed from false to 0 for the status
- info
  the response's property default value changed from true to 2 for the status
- info
  the response's property default value changed from false to 0 for the status
- info
  removed the claude-3-sonnet enum value from the / response property for the response status
- info
  removed the claude-3.5-sonnet enum value from the / response property for the response status
- info
  removed the image color enum value from the / response property for the response status
Jul 17, 2026b80e6dfcf78d Revision changes
- warning
  added the new Agent id is required enum value to the / response property for the response status
- warning
  added the new Agent with id {projectId} not found enum value to the / response property for the response status
- warning
  added the new default enum value to the / response property for the response status
- warning
  added the new openai_content enum value to the / response property for the response status
- warning
  added the new own_content enum value to the / response property for the response status
- info
  api tag Agent Settings added
- info
  api tag Project Settings removed
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  removed the Default enum value from the / response property for the response status
- info
  removed the My Content enum value from the / response property for the response status
- info
  removed the My Content + ChatGPT enum value from the / response property for the response status
- info
  removed the Project id is required enum value from the / response property for the response status
- info
  removed the Project with id {projectId} not found enum value from the / response property for the response status

Operation history (6 revisions)