v1

latestOpenAPI 3.0.22026-07-174617345.8 KB

Agent Settings

Get agent settings.

Retrieve the agent (formerly known as project) settings for a specific agent. This endpoint allows you to fetch the configuration and settings associated with the project. Here is an example to get an agent settings: API SDK.

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

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": "image",
    "chatbot_background": "https://example.com/agent_background.png",
    "chatbot_background_color": "#F5F5F5",
    "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": "Where did this answer come from?",
    "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.",
    "is_loading_indicator_enabled": true,
    "enable_citations": 3,
    "enable_feedbacks": 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",
    "chatbot_model": "gpt-4-o",
    "hide_sources_from_responses": true,
    "user_avatar": "avatar.png",
    "spotlight_avatar": "spotlight_avatar.png",
    "spotlight_avatar_shape": "rectangle",
    "spotlight_avatar_type": "default",
    "user_avatar_orientation": "agent-left-user-right",
    "conversation_retention_period": "year",
    "conversation_retention_days": 180,
    "enable_agent_knowledge_base_awareness": true,
    "markdown_enabled": true
  }
}