Skip to content
View as Markdown

GET AI Settings​

GET
/ai/settings

Return the saved AI writing-assistant configuration.

The stored API key is never returned in clear text — it is masked to **** followed by its last four characters. Sending that masked value back to POST /ai/settings keeps the existing key; sending an empty string clears it.

Required capability: fcrm_manage_settings

Enforced by AiPolicy::getSettings().

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Responses​

Current AI configuration.

application/json
JSON
{
"settings": {
"is_enabled": "string",
"provider": "string",
"model": "string",
"api_key": "string",
"custom_prompt": "string"
},
"has_wordpress_ai": true,
"connectors_url": "string"
}

Playground​

Authorization

Samples​

Powered by VitePress OpenAPI