/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Widget Config

Get Widget Config

Fetch the public AI widget configuration for a project.

GET/v1/projects/{projectId}/chat/configTry it

Returns the public configuration the embeddable chat widget and the doc site's assistant use to render themselves — assistant name, welcome message, starter questions, accent colour, and which agent mode actions the site offers. No authentication required.

Note

On your doc site this endpoint is also served same-origin at GET /_chat/config. The project comes from the site's hostname, so the path takes no projectId.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

Response Fields

NameDescription
projectName:string
The project's name.
assistantName:string
aiPersona.name, or AI Assistant when unset.
welcomeMessage:string
aiPersona.welcomeMessage, or Hi! How can I help you with the documentation? when unset.
suggestedQuestions:string[]
aiPersona.suggestedQuestions, or [].
primaryColor:string
The project's colors.primary, or #6d28d9.
features:object
Which agent mode actions the site offers. Switches only: the support address is never part of this response.
Show 5 child attributesobject

The assistant name and persona are per-project settings; they aren't editable in the dashboard. aiPersona.memory, aiPersona.sharing, support and agent are, under Integrations › Agentic mode — see Agent mode settings.

Error Responses

403 Forbidden

The site is private (password, invite-only or SSO) and the request didn't come through the doc site (FORBIDDEN, "Ask from the docs site").

404 Not Found

The project doesn't exist (NOT_FOUND).

Note

This endpoint is safe to call from the browser and is cached by the widget. See AI Assistant for embedding instructions.

Was this page helpful? Yes No
Request
bashJavaScriptPythonGoRubyPHPJavaC#bash
curl https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/chat/config
Responseapplication/json
json
{
"data": {
"projectName": "Acme Docs",
"assistantName": "AI Assistant",
"welcomeMessage": "Hi! How can I help you with the documentation?",
"suggestedQuestions": ["How do I add a custom domain?"],
"primaryColor": "#6d28d9",
"features": {
"share": true,
"handoff": false,
"reportGap": true,
"memory": true,
"runRequests": false
}
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext