Settings - OpenAI Connections

Bring-your-own AI provider configuration.

📄️ Get Client OpenAI Configuration

Retrieve the client's stored OpenAI connection settings for the validation and remediator services. Requires a bearer token with the 'uid' scope; API keys are not included in the response.

📄️ Test AI Configuration Connection

Test connectivity for the client's stored AI configuration of the given type ('remediator', 'validation' or 'embedding'). The embedding test also asserts the vector width the index requires. Returns 400 for an invalid ai_type or a failed connection test, and 404 if the client is not found.

📄️ Save OpenAI Validation Connection

Validate and save the OpenAI-compatible connection used by the validation service. The connection is tested before saving; 400 is returned on invalid URLs or failed tests.

📄️ Save OpenAI Remediator Connection

Validate and save the OpenAI-compatible connection used by the AI remediation engine. The connection is tested before saving; 400 is returned on invalid URLs or failed tests.

📄️ Save the whole BYOAI configuration (fast, smart and embeddings)

Validate and save the three blocks a BYOAI tenant must provide: the fast chat model, the smart chat model and the embeddings endpoint. All three are tested before anything is written, and they are written together — a partial BYOAI would break every AI SAST scan. The embedding model id is fixed platform-side; only its endpoint and key are taken from the request. Returns 400 on any failed test.

📄️ Test a BYOAI block from the form without saving

Dry-run the connectivity probe for one BYOAI block — 'validation' (fast), 'remediator' (smart) or 'embedding' — against the request body (the current form values), without persisting anything. Mirrors PUT /connections/byoai: every connection is the same generic OpenAI-compatible client, an empty api_key reuses the stored one, and the embeddings model is fixed platform-side. Returns 400 on a failed probe. Requires the ai_byoai plan feature.

📄️ Reset the AI connections to the Plexicus defaults

Clear the client's own model overrides so every connection falls back to the platform (environment-configured) defaults. ai_type is 'validation' (fast), 'remediator' (smart) or 'embedding'; whichever is named, the THREE blocks are reset together, because a partial BYOAI breaks every scan. Requires the ai_byoai plan feature.