Join Community
DocsDeveloper GuideAPI DocumentationChangelog
Projects

Update Project Settings

Update the AI agent settings for a project.

Update the AI agent configuration for a project. Only the fields you include will be updated — everything else stays unchanged.

Authorization

Your API token must have one of the following:

  • Access Role: Owner or Editor (broad access), OR
  • Fine-grained Permission: Setting module with Write enabled
POST
/updateProjectSettings

Authorization

bearerToken

AuthorizationBearer <token>

API token for YourGPT Public APIs. Create tokens in Settings > API Tokens in your YourGPT dashboard.

In: header

Request Body

application/json

project_uid*string

The project UID to update settings for.

prompt?string

System prompt for the AI agent.

restriction?string

Restriction instructions for the AI agent.

model?string

AI model to use. Some models may not be available on all plans.

temperature?number

Model temperature. Lower values are more deterministic, higher values more creative.

Range0 <= value <= 2
mode?string

AI mode. 'agent' can use tools and functions, 'chat' is simple Q&A.

Value in"agent" | "chat"
chat_history_count?integer

Number of previous messages to include as context.

Range0 <= value <= 50
max_nodes?integer

Number of knowledge base nodes to retrieve per query.

Range1 <= value <= 10
add_page_link?integer

Include source page links in AI responses. 0 = no, 1 = yes.

Value in0 | 1
auto_close_duration?integer

Auto-close conversations after N minutes of inactivity (5–43200). Closes permanently — a new session starts on next interaction.

Range5 <= value <= 43200
auto_resolve_duration?integer

Auto-resolve conversations after N minutes of inactivity (5–43200). Marks as resolved — users can resume the same conversation.

Range5 <= value <= 43200

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.yourgpt.ai/chatbot/v1/updateProjectSettings" \  -H "Content-Type: application/json" \  -d '{    "project_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"  }'
{
  "type": "RXSUCCESS",
  "message": "Project setting updated successfully"
}

{
  "type": "RXERROR",
  "message": "Invalid model 'gpt-99'. Model not found in available models list."
}

{
  "type": "RXERROR",
  "message": "Invalid or revoked API token"
}
{
  "type": "RXERROR",
  "message": "You do not have permission to perform this action"
}

Available Models

To get the list of supported models with their exact identifiers, call the Get Supported Models API:

curl -X POST https://api.yourgpt.ai/chatbot/v1/getSupportedModels \
  -H "Content-Type: application/json" \
  -d '{}'

Use the value field from the response as the model parameter.

Parameter Guide

ParameterTypeRangeDescription
promptstring—System prompt that defines the AI agent's behavior and personality
restrictionstring—Instructions for what the AI should NOT do
modelstringSee API aboveAI model identifier (use exact value from Get Supported Models)
temperaturenumber0 to 2Controls response randomness. 0.2 = factual, 0.7 = balanced, 1.0+ = creative
modestringagent or chatagent = can use tools and functions, chat = simple Q&A
chat_history_countinteger0 to 50Number of previous messages the AI sees as context
max_nodesinteger1 to 10Knowledge base chunks retrieved per query
add_page_linkinteger0 or 1Include source page links in responses
auto_close_durationinteger5 to 43200Minutes of inactivity before conversation is permanently closed
auto_resolve_durationinteger5 to 43200Minutes of inactivity before conversation is marked as resolved