aiOpenaiChatCompletions
Map aiOpenaiChatCompletions(profileId, AiOpenaiChatCompletionsRequest)
POST /api/2.0/ai/openai/{profileId}/v1/chat/completions
OpenAI chat completions passthrough
OpenAI-compatible chat completions for the document editor's AI plugin. The profile is resolved server-side, its credentials are attached, and the body is forwarded to the provider verbatim - the payload is owned by the plugin's SDK on one end and the provider on the other. A client disconnect cancels the provider call.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| profileId | path | String | The AI provider profile identifier. | [required] [example: 00000000-0000-0000-0000-000000000000] |
| AiOpenaiChatCompletionsRequest | body | Map | An OpenAI Chat Completions request, forwarded to the provider byte for byte. The shape is the provider's, not this API's, so consult the provider's own reference; the model and the credentials come from the profile in the path and must not be sent here. | [required] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The provider's own response, relayed verbatim with its status and content type. | Map | - |
| 401 | Missing asc_auth_key cookie or Authorization header. | AiErrorResponse | - |
| 403 | AI is disabled for this portal, the caller is a guest, or the room named by entityId is one the caller cannot open. Relayed from the DocSpace AI service or the Files API. | aiOpenaiChatCompletions_403_response | - |
| 404 | No profile with this identifier exists for the caller. | aiOpenaiChatCompletions_403_response | - |
| 413 | The request body is larger than this route accepts. | aiOpenaiChatCompletions_403_response | - |
| 429 | Relayed verbatim from the AI provider, which is rate-limiting this portal's key. | aiOpenaiChatCompletions_403_response | - |
| 500 | Unhandled failure. The reason is logged server-side and never echoed back. | aiOpenaiChatCompletions_403_response | - |
| 502 | The AI provider could not be reached, or answered with a failure of its own. | aiOpenaiChatCompletions_403_response | - |
Return type
Map
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json