ONLYOFFICE DocSpace AI API

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/x-ndjson, application/json

aiAiDenyToolCall

AiChatEvent aiAiDenyToolCall(AiAiToolCallData)

POST /api/2.0/ai/ai/deny-tool-call

Deny tool call

Refuses the tool call a chat round is paused on and resumes it immediately, streaming the continuation as newline-delimited ChatEvent objects. The literal User deny tool call is persisted in place of the tool result, so the model sees an explicit refusal rather than a missing answer and may reply without the tool or ask for something else. Nothing is executed and no result is accepted from the caller. Use POST api/2.0/ai/ai/approve-tool-call to supply a result instead.

Parameters

Name	In	Type	Description	Notes
AiAiToolCallData	body	AiAiToolCallData		[required]

Responses

Status code	Description	Type	Response headers
200	Newline-delimited stream of chat events — one JSON `ChatEvent` object per line.	AiChatEvent	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/x-ndjson, application/json

aiAiRegenerateStream

AiChatEvent aiAiRegenerateStream(aiAiRegenerateStream_request)

POST /api/2.0/ai/ai/regenerate-stream

Regenerate stream

Re-rolls the last assistant reply of an existing thread: every message after the last user message - the previous reply and any tool-call hops - is dropped, and a fresh reply is streamed as newline-delimited ChatEvent objects against the unchanged prompt. The thread has to exist already, threadId is required, and no title is generated. The dropped messages are gone for good, so this is a destructive operation on the thread's tail rather than a retry that keeps both answers. Unlike send-with-stream the profile is not verified before the stream opens, so an unusable model surfaces as an error frame inside the 200 rather than as a 4xx.

Parameters

Name	In	Type	Description	Notes
aiAiRegenerateStream_request	body	aiAiRegenerateStream_request		[required]

Responses

Status code	Description	Type	Response headers
200	Newline-delimited stream of chat events — one JSON `ChatEvent` object per line.	AiChatEvent	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/x-ndjson, application/json

aiAiSend

AiThreadMessageLike aiAiSend(aiAiSend_request)

POST /api/2.0/ai/ai/send

Run an AI action

Runs one AI action and returns the whole answer as a single JSON document. The model is the profile bound to actionType, falling back to the Default assignment slot, so this operation accepts no profileId of its own. Nothing is persisted - no thread is opened, no message is stored and no title is generated - which makes it the one to use for a stand-alone completion rather than for a conversation. entityId and contextEntityId set the scope of the round, which decides the workspace context and the custom MCP servers it may reach. For a conversation that keeps its history, use POST api/2.0/ai/ai/send-with-stream instead.

Parameters

Name	In	Type	Description	Notes
aiAiSend_request	body	aiAiSend_request		[required]

Responses

Status code	Description	Type	Response headers
200	The assistant's reply as one message. Nothing was persisted.	AiThreadMessageLike	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiThreadMessageLike

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAiSendCustom

AiThreadMessageLike aiAiSendCustom(aiAiSendCustom_request)

POST /api/2.0/ai/ai/send-custom

Send custom

Runs a free-form one-turn call against a system prompt supplied in the request, with no thread, no history and nothing persisted. The model is the explicit profileId when it resolves, otherwise the Default assignment slot. The shape of the answer depends on the body rather than on the route: with isStream set it arrives as a newline-delimited stream of chat events, and without it as a single JSON document, so a client has to handle both. Use POST api/2.0/ai/ai/send when the prompt should come from the portal's own action configuration instead of from the caller.

Parameters

Name	In	Type	Description	Notes
aiAiSendCustom_request	body	aiAiSendCustom_request		[required]

Responses

Status code	Description	Type	Response headers
200	The assistant's reply as one message, or a newline-delimited stream of chat events when `isStream` was set. Nothing was persisted.	AiThreadMessageLike	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiThreadMessageLike

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAiSendWithStream

AiChatEvent aiAiSendWithStream(AiAiSendStreamBody)

POST /api/2.0/ai/ai/send-with-stream

Send with stream

Runs one chat round and streams it back as newline-delimited ChatEvent objects. Omitting threadId opens a new thread, which requires that entityId names a room the caller can open and that a profile resolves for it; the user message and the reply are persisted either way, and a new thread also gets a generated title. The model is settled in a fixed order - an agent's assignment in scope overrides everything, then the explicit profileId, then the one stored on the thread, then the Chat assignment - and the effective profile is checked before the stream opens, so an unknown one fails with 400 rather than as an error buried in a 200. A tool call pauses the round and ends the stream; resume it with POST api/2.0/ai/ai/approve-tool-call or POST api/2.0/ai/ai/deny-tool-call.

Parameters

Name	In	Type	Description	Notes
AiAiSendStreamBody	body	AiAiSendStreamBody		[required]

Responses

Status code	Description	Type	Response headers
200	Newline-delimited stream of chat events — one JSON `ChatEvent` object per line.	AiChatEvent	-
400	The prompt is empty, more attachments were sent than the limit allows, or no AI profile could be resolved for the requested action.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
402	The portal has no paid AI quota left, so the profile bound to this action cannot be dispatched.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The `entityId` names a room the caller cannot open, or no live profile is bound to it.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/x-ndjson, application/json

aiAiSendWithStreamOpenAI

AiOpenAIStreamChunk aiAiSendWithStreamOpenAI(AiAiSendStreamBody)

POST /api/2.0/ai/ai/send-with-stream-openai

Stream a chat in OpenAI format

The same chat round as send-with-stream, re-encoded as a server-sent-events stream of OpenAI chat.completion.chunk objects terminated by a [DONE] sentinel. Thread handling, persistence, title generation and the profile pre-flight are identical, and a tool call ends the stream with finish_reason: tool_calls instead of a pause event - resume it through the same approve and deny operations. Unlike send-with-stream it does not reject an empty user message and does not enforce the per-kind attachment cap, so validate both before calling. Choose this route only for a client that already speaks the OpenAI wire format; POST api/2.0/ai/ai/send-with-stream is the native one.

Parameters

Name	In	Type	Description	Notes
AiAiSendStreamBody	body	AiAiSendStreamBody		[required]

Responses

Status code	Description	Type	Response headers
200	Server-sent events stream of OpenAI `chat.completion.chunk` objects, terminated by a `[DONE]` sentinel.	AiOpenAIStreamChunk	-
400	The prompt is empty, or no AI profile could be resolved for the requested action.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
402	The portal has no paid AI quota left, so the profile bound to this action cannot be dispatched.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiOpenAIStreamChunk

Authorization

AiFolderIntegerWrapper

HTTP request headers

Content-Type: application/json
Accept: text/event-stream, application/json

AIAgentsApi

aiAgentsCreate

AiFolderIntegerWrapper aiAgentsCreate(aiAgentsCreate_request)

POST /api/2.0/ai/agents

Create an agent

Creates an AI agent room and binds a model to it, in that order. profileId is required, has to be a UUID, has to name an existing profile, and that profile has to support chat - an image-only model is refused here rather than failing on every later request. prompt is required and is stored on the room as its standing instruction with any markup stripped, so it cannot round-trip HTML into another user's reply. The two steps are not atomic: when the room is created but the model binding fails, the call reports an error and the room is left behind, so re-bind it with PUT api/2.0/ai/agents/{id} rather than creating a second one.

Parameters

Name	In	Type	Description	Notes
aiAgentsCreate_request	body	aiAgentsCreate_request		[required]

Responses

Status code	Description	Type	Response headers
200	The created agent room, with the model already bound to it.	AiFolderIntegerWrapper	-
400	`profileId` is missing, is not a UUID, names no existing profile, or names one that does not support chat; or `prompt` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiFileOperationWrapper

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAgentsDelete

AiFileOperationWrapper aiAgentsDelete(id, aiAgentsDelete_request)

DELETE /api/2.0/ai/agents/{id}

Delete an agent

Deletes an AI agent room. The ID has to be the room's integer identifier, and the body is forwarded to the DocSpace AI service unchanged, so it accepts the same options as deleting an ordinary room - deleteAfter among them. Deletion is asynchronous there: the answer is a file-operation payload to poll, not a completed result. The agent's model binding is deliberately left behind, because the upstream assignment API has no per-entry delete, so an orphaned assignment row survives the room.

Parameters

Name	In	Type	Description	Notes
id	path	String	The agent identifier.	[required] [example: `1234`]
aiAgentsDelete_request	body	aiAgentsDelete_request		[required]

Responses

Status code	Description	Type	Response headers
200	The queued file operation. Deletion runs asynchronously, so poll DocSpace for its outcome.	AiFileOperationWrapper	-
400	The agent ID is not a positive integer.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

aiAgentsGet_200_response

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAgentsGet

aiAgentsGet_200_response aiAgentsGet(id)

GET /api/2.0/ai/agents/{id}

Get an agent

Returns one AI agent room, enriched with the profileId currently bound to it so an edit form can prefill its model selector. The ID is the room's integer identifier, and a non-integer value is refused rather than passed on to fail opaquely upstream. The binding lives in an assignment rather than on the room, so it is looked up separately: a missing or unreadable assignment simply leaves profileId out of the answer instead of failing the call. The standing instruction comes back on the room as chatSettings.prompt.

Parameters

Name	In	Type	Description	Notes
id	path	String	The agent identifier.	[required] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The agent room, with `profileId` added when a model is bound to it.	aiAgentsGet_200_response	-
400	The agent ID is not a positive integer.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiFolderContentIntegerWrapper

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiAgentsList

AiFolderContentIntegerWrapper aiAgentsList(subjectId, subjectOwnerId, excludeSubject, tags, withoutTags, quotaFilter, filterValue, sortBy, sortOrder, startIndex, count)

GET /api/2.0/ai/agents

List agents

Lists the portal's AI agent rooms. The query is forwarded unchanged to the DocSpace AI service, so it takes the same paging, sorting and filtering parameters as an ordinary room listing, and the answer is that service's folder-content payload rather than a shape of this API's own. Array and object query values are dropped rather than guessed at, so send flat strings. The profile bound to each agent is not included here - read one agent with GET api/2.0/ai/agents/{id} for that.

Parameters

Name	In	Type	Description	Notes
subjectId	query	String	Show only the agent rooms this user takes part in.	[optional] [example: `00000000-0000-0000-0000-000000000000`]
subjectOwnerId	query	String	Show only the agent rooms owned by this user.	[optional] [example: `00000000-0000-0000-0000-000000000000`]
excludeSubject	query	Boolean	Invert the user filter: leave out what `subjectId` selects instead of keeping it.	[optional] [example: `false`]
tags	query	String	Show only the agent rooms carrying these tags, comma-separated.	[optional] [example: `ai,assistant`]
withoutTags	query	Boolean	Show only the agent rooms that carry no tags at all.	[optional] [example: `false`]
quotaFilter	query	Integer	Filter by quota kind: 0 for all, 1 for the default quota, 2 for a custom one.	[optional] [example: `0`]
filterValue	query	String	Show only the agent rooms whose title matches this text.	[optional] [example: `assistant`]
sortBy	query	String	Field to sort by, for example `DateAndTime`.	[optional] [example: `DateAndTime`]
sortOrder	query	String	Sort direction, `ascending` or `descending`.	[optional] [example: `descending`]
startIndex	query	Integer	Index of the first entry to return; 0 starts at the beginning.	[optional] [example: `0`]
count	query	Integer	How many entries to return. The internal service applies its own default.	[optional] [example: `25`]

Responses

Status code	Description	Type	Response headers
200	The agent rooms, in the DocSpace AI service's folder-content envelope.	AiFolderContentIntegerWrapper	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiNewItemsAgentNewItemsArrayWrapper

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiAgentsNews

AiNewItemsAgentNewItemsArrayWrapper aiAgentsNews()

GET /api/2.0/ai/agents/news

List agent news items

Lists the unread items across the caller's AI agent rooms, so a badge can be rendered without walking each room. It takes no parameters and is scoped to the caller by the DocSpace AI service. The answer is that service's new-items payload. This is a read-only operation and does not mark anything as seen.

Parameters

This endpoint does not need any parameter.

Responses

Status code	Description	Type	Response headers
200	The unread items of the caller's agent rooms.	AiNewItemsAgentNewItemsArrayWrapper	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiFolderIntegerArrayWrapper

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiAgentsResetQuota

AiFolderIntegerArrayWrapper aiAgentsResetQuota(aiAgentsResetQuota_request)

PUT /api/2.0/ai/agents/resetquota

Reset agents' quota

Returns the listed AI agent rooms to the portal's default storage quota, forwarding roomIds to the DocSpace AI service unchanged. The answer is that service's payload, one updated room per entry. This is the counterpart of PUT api/2.0/ai/agents/agentquota and takes no quota value of its own. Rooms already on the default are unaffected.

Parameters

Name	In	Type	Description	Notes
aiAgentsResetQuota_request	body	aiAgentsResetQuota_request		[required]

Responses

Status code	Description	Type	Response headers
200	The updated agent rooms, one entry each.	AiFolderIntegerArrayWrapper	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiFolderIntegerWrapper

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAgentsUpdate

AiFolderIntegerWrapper aiAgentsUpdate(id, aiAgentsUpdate_request)

PUT /api/2.0/ai/agents/{id}

Update an agent

Changes an AI agent room - its title, tags or standing instruction - and optionally rebinds its model. The ID has to be the room's integer identifier. profileId is not part of the room contract: it is taken out of the forwarded body and applied afterwards as the agent's assignment, and it has to be a UUID naming an existing chat-capable profile. An instruction sent as chatSettings.prompt has its markup stripped, as on create; note that when chatSettings is present the upstream service still requires the rest of that object to be valid, so send it whole.

Parameters

Name	In	Type	Description	Notes
id	path	String	The agent identifier.	[required] [example: `1234`]
aiAgentsUpdate_request	body	aiAgentsUpdate_request		[required]

Responses

Status code	Description	Type	Response headers
200	The updated agent room.	AiFolderIntegerWrapper	-
400	The agent ID is not a positive integer, or `profileId` is not a UUID, names no existing profile, or names one that does not support chat.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiFolderIntegerArrayWrapper

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAgentsUpdateQuota

AiFolderIntegerArrayWrapper aiAgentsUpdateQuota(aiAgentsUpdateQuota_request)

PUT /api/2.0/ai/agents/agentquota

Update agents' quota

Sets the storage quota of the listed AI agent rooms in one call, forwarding roomIds and quota to the DocSpace AI service unchanged. The answer is that service's payload, one updated room per entry. A quota applies to the room's stored files, not to the model usage of its chats. Use PUT api/2.0/ai/agents/resetquota to return rooms to the portal default instead of naming a number.

Parameters

Name	In	Type	Description	Notes
aiAgentsUpdateQuota_request	body	aiAgentsUpdateQuota_request		[required]

Responses

Status code	Description	Type	Response headers
200	The updated agent rooms, one entry each.	AiFolderIntegerArrayWrapper	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiAssignmentMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

AIAssignmentsApi

aiAssignmentsAssign

AiAssignmentMutationResult aiAssignmentsAssign(aiAssignmentsAssign_request)

PUT /api/2.0/ai/assignments/assign

Bind a profile to an action

Binds a profile to one AI action portal-wide, creating the assignment or replacing it in place, and returns the result. Both actionType and profileId are required. The profile's declared capabilities are checked against the action, so a model that cannot generate images cannot be bound to ImageGeneration - the Default slot is exempt, because it stands in for every action. There is no room-scoped form of this write: a room's own binding is created by the agent that owns it, while reads accept an entityId.

Parameters

Name	In	Type	Description	Notes
aiAssignmentsAssign_request	body	aiAssignmentsAssign_request		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the binding was stored. A failure is reported in `error` rather than as a status.	AiAssignmentMutationResult	-
400	`actionType` or `profileId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiBulkAssignmentResult

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAssignmentsBulkAssign

AiBulkAssignmentResult aiAssignmentsBulkAssign(request_body)

PUT /api/2.0/ai/assignments/bulk-assign

Bulk assign

Applies many action-to-profile bindings in one write, which is how a settings screen saves the whole set. The body is a plain map of action type to profile ID, and every entry is validated before anything is written: one unknown action or one non-string profile ID rejects the request whole, so the set is never left half-applied. Each entry behaves as the single assign operation does, capability checks included. The answer carries the resulting assignment set.

Parameters

Name	In	Type	Description	Notes
request_body	body	Map	A map of action type to profile ID. Every key has to be a known action type and every value a profile ID; one bad entry rejects the whole map.	[required]

Responses

Status code	Description	Type	Response headers
200	Whether the set was stored, with `errors` listing the entries that were refused.	AiBulkAssignmentResult	-
400	The body is not a map of action type to profile ID, or one of its keys is not a known action type.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAssignmentsCascadeProfileDelete

AiSuccessResponse aiAssignmentsCascadeProfileDelete(aiAssignmentsCascadeProfileDelete_request)

DELETE /api/2.0/ai/assignments/cascade-profile-delete

Cascade profile delete

Detaches a profile from every assignment that points at it, which is the cleanup step before the profile itself is removed. The Default slot is promoted to the first remaining profile, or dropped when none is left, and every other slot holding the profile is cleared. profileId is required and may be sent in the body or as a query parameter. DELETE api/2.0/ai/profiles/delete already does this, so call it directly only when the profile is being removed by some other means.

Parameters

Name	In	Type	Description	Notes
aiAssignmentsCascadeProfileDelete_request	body	aiAssignmentsCascadeProfileDelete_request	The profile to detach from every assignment. May be sent as the `profileId` query parameter instead of in the body.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms no assignment points at the profile any more.	AiSuccessResponse	-
400	`profileId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAssignmentsGetAllAssignments

Map aiAssignmentsGetAllAssignments(entityId)

GET /api/2.0/ai/assignments/get-all-assignments

Get all assignments

Returns every action-to-profile binding of a scope as one map, which is what a settings screen loads. entityId narrows it to a room and has to name one the caller can open; a room that is not an agent room degrades to the portal-wide set rather than answering empty, and omitting the parameter reads the portal-wide set directly. Actions with no binding are simply absent from the map. The Default slot is reported as an entry of its own rather than being folded into the others.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The scope's bindings as a map of action type to profile ID. An action with no binding is absent.	Map	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Map

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiAssignmentsGetAssignment

String aiAssignmentsGetAssignment(actionType)

GET /api/2.0/ai/assignments/get-assignment

Get assignment

Returns the profile bound to one AI action, without applying the Default fallback - an empty answer means this action has no profile of its own, not that nothing is configured. actionType is required and is read from the query. Use GET api/2.0/ai/assignments/resolve-for-action to learn which profile would actually serve the action. This reads the portal-wide binding and accepts no entityId.

Parameters

Name	In	Type	Description	Notes
actionType	query	String	The AI action the request applies to - one of Default, Chat, Code, Summarization, Translation, TextAnalyze, ImageGeneration, OCR, Vision.	[required] [example: `Chat`]

Responses

Status code	Description	Type	Response headers
200	The profile bound to the action, or an empty result when it has none of its own.	String	-
400	`actionType` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

String

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiAssignmentsResolveForAction

AiResolvedAssignment aiAssignmentsResolveForAction(actionType, entityId)

GET /api/2.0/ai/assignments/resolve-for-action

Resolve for action

Returns the profile that will serve one AI action, falling back to the Default slot when the action has no profile of its own. actionType is required and has to be one of the known actions - an unknown or misspelled value is rejected rather than resolved to the default. entityId narrows the lookup to a room, and a room with no assignment of its own degrades to the portal-wide one. This fails when neither slot is set or the bound profile is gone, so use GET api/2.0/ai/assignments/try-resolve-for-action when an unconfigured portal should answer empty instead.

Parameters

Name	In	Type	Description	Notes
actionType	query	String	The AI action the request applies to - one of Default, Chat, Code, Summarization, Translation, TextAnalyze, ImageGeneration, OCR, Vision.	[required] [example: `Chat`]
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The profile that will serve the action.	AiResolvedAssignment	-
400	`actionType` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiResolvedAssignment

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiAssignmentsTryResolveForAction

AiResolvedAssignment aiAssignmentsTryResolveForAction(actionType, entityId)

GET /api/2.0/ai/assignments/try-resolve-for-action

Try resolve for action

Returns the profile that will serve one AI action, exactly as GET api/2.0/ai/assignments/resolve-for-action does, but answers with an empty result rather than failing when nothing is configured. actionType is required and is validated the same way, and entityId narrows the lookup to a room. This is the operation to call when the absence of a profile is a normal state to render - a settings screen, or a feature that hides itself. Both operations are read-only.

Parameters

Name	In	Type	Description	Notes
actionType	query	String	The AI action the request applies to - one of Default, Chat, Code, Summarization, Translation, TextAnalyze, ImageGeneration, OCR, Vision.	[required] [example: `Chat`]
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The profile that will serve the action, or an empty result when none is configured.	AiResolvedAssignment	-
400	`actionType` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiResolvedAssignment

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiAssignmentsUnassign

AiSuccessResponse aiAssignmentsUnassign(body)

DELETE /api/2.0/ai/assignments/unassign

Clear an action's profile

Clears the portal-wide binding of one AI action, after which the action falls back to the Default slot. actionType is required and may be sent in the body or as a query parameter. An action whose slot is already empty is not reported as an error - the call answers success either way, so it is safe to repeat. Clearing Default itself leaves the actions that relied on it unresolvable.

Parameters

Name	In	Type	Description	Notes
body	body	String		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the action now has no profile of its own.	AiSuccessResponse	-
400	`actionType` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

AIAttachmentsApi

aiAttachmentsDelete

AiSuccessResponse aiAttachmentsDelete(body)

DELETE /api/2.0/ai/attachments/delete

Delete one attachment

Permanently deletes one attachment, whether it is still a draft or already bound to a message. The ID is not validated here, so a malformed one surfaces as an error relayed from storage rather than as a 400, and an ID that does not exist answers success without deleting anything. Deleting a bound attachment leaves the message in place without it. The deletion cannot be undone.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the attachment to delete, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the request was accepted, whether or not anything was deleted.	AiSuccessResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAttachmentsDeleteMany

AiSuccessResponse aiAttachmentsDeleteMany(request_body)

DELETE /api/2.0/ai/attachments/delete-many

Delete many

Permanently deletes several attachments in one round trip. ids is optional and an absent value is treated as an empty list, so a malformed request quietly deletes nothing instead of failing. IDs that do not exist are skipped without being reported, so the answer confirms only that the call was accepted. The deletions cannot be undone.

Parameters

Name	In	Type	Description	Notes
request_body	body	List	The IDs of the attachments to delete, as a bare JSON array of strings.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the request was accepted, whether or not anything was deleted.	AiSuccessResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAttachmentsGet

AiAttachment aiAttachmentsGet(body)

POST /api/2.0/ai/attachments/get

Get one attachment

Returns one attachment by its ID, whether it is still a draft or already bound to a message. The ID is required and has to be a non-empty string. An ID that no longer exists is not reported as 404: the answer is a null body with status 200, so treat a missing payload as no such attachment. Use POST api/2.0/ai/attachments/get-many to read several at once.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the attachment to read, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	The attachment, or a null body when no attachment has that ID.	AiAttachment	-
400	The attachment ID is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiAttachment

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAttachmentsGetMany

List aiAttachmentsGetMany(request_body)

POST /api/2.0/ai/attachments/get-many

Get many

Returns several attachments in one call, aligned by position with the ids that were sent, so the answer can be zipped straight onto the request. An ID that no longer exists leaves its slot empty rather than shortening the list, which is how a caller tells which of them are gone. ids has to be present and non-empty - an empty batch is rejected rather than answered with an empty list. Nothing is changed by the call.

Parameters

Name	In	Type	Description	Notes
request_body	body	List	The IDs of the attachments to read, as a bare JSON array of strings. The answer is aligned with this array by position.	[required]

Responses

Status code	Description	Type	Response headers
200	The attachments, aligned by position with the IDs that were sent. A missing one leaves its slot empty.	List	-
400	The list of attachment IDs is malformed.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAttachmentsLinkToMessage

AiSuccessResponse aiAttachmentsLinkToMessage(aiAttachmentsLinkToMessage_request)

POST /api/2.0/ai/attachments/link-to-message

Link to message

Binds draft attachments to the chat message that owns them, after that message has been persisted, so that deleting the message removes them too. All three of ids, messageId and threadId are required, and the references are verified rather than trusted: an unknown message answers 404, a message that belongs to a different thread answers 400, and attachments that no longer exist answer 404 naming each missing ID. That verification exists because the underlying binding call skips unknown IDs silently, which used to report success for a link that had not happened. Drafts stay unbound until this succeeds.

Parameters

Name	In	Type	Description	Notes
aiAttachmentsLinkToMessage_request	body	aiAttachmentsLinkToMessage_request		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the attachments are now bound to the message.	AiSuccessResponse	-
400	The attachment or message reference is malformed.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The message or the attachment does not exist.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAttachmentsSaveFile

AiAttachment aiAttachmentsSaveFile(aiAttachmentsSaveFile_request)

POST /api/2.0/ai/attachments/save-file

Save file

Stores one file attachment as a draft and returns it, so its ID can be attached to a message later. input carries the host path - the DocSpace entry ID the AI backend resolves server-side - the text content already extracted from that file, the ONLYOFFICE numeric file type, and optionally a title; the text is what the model reads, so this operation does not open the file itself. Archives are refused outright, whatever their declared name says. Drafts are not bound to a conversation until POST api/2.0/ai/attachments/link-to-message is called, so an unlinked draft outlives the round that created it.

Parameters

Name	In	Type	Description	Notes
aiAttachmentsSaveFile_request	body	aiAttachmentsSaveFile_request		[required]

Responses

Status code	Description	Type	Response headers
200	The stored draft, whose ID links it to a message later.	AiAttachment	-
400	The attachment payload is malformed.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiAttachment

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiAttachmentsSaveFilesMany

List aiAttachmentsSaveFilesMany(aiAttachmentsSaveFilesMany_request)

POST /api/2.0/ai/attachments/save-files-many

Save files many

Stores several file attachments as drafts in one round trip and returns them in the order they were sent. Each entry is validated exactly as the single-file operation validates its input, and the first bad one rejects the whole batch with its index named in the message - nothing is stored. inputs has to be present and an array: an absent or null value is a malformed request rather than an empty batch, and only an explicit empty array means no files. Follow up with POST api/2.0/ai/attachments/link-to-message to bind the drafts to a message.

Parameters

Name	In	Type	Description	Notes
aiAttachmentsSaveFilesMany_request	body	aiAttachmentsSaveFilesMany_request		[required]

Responses

Status code	Description	Type	Response headers
200	The stored drafts, in the order they were sent.	List	-
400	`inputs` is not an array, or one of its entries is malformed.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

aiEditorToolsCall_200_response

HTTP request headers

Content-Type: application/json
Accept: application/json

AIEditorToolsApi

aiEditorToolsCall

aiEditorToolsCall_200_response aiEditorToolsCall(aiEditorToolsCall_request)

POST /api/2.0/ai/editor-tools/call

Call an editor tool

Executes one DocSpace tool on behalf of the document editor's AI plugin, server-side and under the caller's own credentials, so the browser never holds the transport. name has to be one of the tools GET api/2.0/ai/editor-tools/list reports; anything else, including a tool the editor is not allowed to reach, is refused. The result is always returned as a string - a structured result is serialised - because the plugin relays it to the model verbatim. A tool that fails does so inside that string as an error payload rather than as an HTTP status, so check the content before trusting it.

Parameters

Name	In	Type	Description	Notes
aiEditorToolsCall_request	body	aiEditorToolsCall_request	The tool to run: `name` from `GET api/2.0/ai/editor-tools/list`, `arguments` matching that tool's input schema, and an optional `entityId` for the room to run it in.	[required]

Responses

Status code	Description	Type	Response headers
200	The tool's output as a string. A tool that failed reports it inside that string.	aiEditorToolsCall_200_response	-
400	The tool name is not one this portal exposes.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

aiEditorToolsList_200_response

HTTP request headers

Content-Type: application/json
Accept: application/json

aiEditorToolsList

aiEditorToolsList_200_response aiEditorToolsList()

GET /api/2.0/ai/editor-tools/list

List editor tools

Returns the catalogue of DocSpace tools the document editor's AI plugin may offer the model - the same composed set the DocSpace chat sees, minus the two web-search tools the editor already reaches through its own passthrough. entityId scopes the catalogue to a room, which decides the room-specific tools it contains. Each entry carries exactly four fields: the tool name, its description, its input schema, and whether calling it requires an approval dialog; nothing else is exposed, because the raw listings of system servers carry transport details that must not reach a browser. The approval flag follows the same policy the chat engine applies, and a read-only tool comes back needing none - execute a tool with POST api/2.0/ai/editor-tools/call, which accepts only the names this catalogue reports.

Parameters

This endpoint does not need any parameter.

Responses

Status code	Description	Type	Response headers
200	The tools the editor plugin may offer the model, four fields each.	aiEditorToolsList_200_response	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

aiExportTextToDocx_202_response

HTTP request headers

Content-Type: Not defined
Accept: application/json

AIExportApi

aiExportTextToDocx

aiExportTextToDocx_202_response aiExportTextToDocx(aiExportTextToDocx_request)

POST /api/2.0/ai/text-to-docx

Start markdown → docx export

Queues a markdown-to-docx export and answers 202 as soon as the job is accepted, without waiting for it. title, content and folderId are all required, and a content of only whitespace counts as missing even though it is not empty. The conversion runs in the AI worker, which saves the .docx into the target folder - an agent room resolves to its own result-storage subfolder - so there is nothing to poll here: completion arrives as the ordinary folder-modified socket event. This route accepts a body of up to 15 MB rather than the 100 KB the rest of the API allows, because a whole thread transcript is sent in one request.

Parameters

Name	In	Type	Description	Notes
aiExportTextToDocx_request	body	aiExportTextToDocx_request		[required]

Responses

Status code	Description	Type	Response headers
202	Confirms the export was queued. The .docx arrives in the target folder later, announced by a folder-modified socket event.	aiExportTextToDocx_202_response	-
400	`title`, `content` or `folderId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The transcript is larger than 15 MB, this route's own parser limit.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

AIOpenAIPassthroughApi

aiOpenaiChatCompletions

Map aiOpenaiChatCompletions(profileId, request_body)

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`]
request_body	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, or the caller is a guest. Relayed from the DocSpace AI service.	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

aiOpenaiImagesGenerations

Map aiOpenaiImagesGenerations(profileId, request_body)

POST /api/2.0/ai/openai/{profileId}/v1/images/generations

OpenAI image generation passthrough

OpenAI-compatible image generation for the document editor's AI plugin, working exactly as the chat-completions passthrough does: the profile named by profileId is resolved server-side, its credentials are attached, and the body reaches the provider unchanged. The provider's status and body are relayed verbatim, so its 429 and its own error envelope surface as they stand. A body larger than this route accepts is refused before it is forwarded. A client disconnect aborts the provider call.

Parameters

Name	In	Type	Description	Notes
profileId	path	String	The AI provider profile identifier.	[required] [example: `00000000-0000-0000-0000-000000000000`]
request_body	body	Map	An OpenAI image-generation request, forwarded to the provider byte for byte. The shape is the provider's, not this API's, and the credentials come from the profile in the path.	[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, or the caller is a guest. Relayed from the DocSpace AI service.	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

AIPreferencesApi

aiPreferencesClearDeepMode

AiSuccessResponse aiPreferencesClearDeepMode(body)

DELETE /api/2.0/ai/preferences/clear-deep-mode

Clear deep mode

Removes the stored extended-thinking setting of a scope (the depth and, with it, the deep-mode toggle), after which reads fall back to the configured default rather than to false. entityId picks a room and omitting it clears the portal-wide preference. Clearing a scope that has no stored value is not an error. This differs from storing false, which is an explicit choice a later read reports as set.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the room whose preference is cleared, as a bare JSON string. Send an empty body to clear the portal-wide preference.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the scope has no preference of its own and now inherits the default.	AiSuccessResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiPreferencesGetDeepMode

Boolean aiPreferencesGetDeepMode(entityId)

GET /api/2.0/ai/preferences/get-deep-mode

Get deep mode

Returns the deep-mode toggle of a scope, as a bare boolean: whether the stored extended-thinking depth is above off. entityId picks a room and omitting it reads the portal-wide preference. A scope that has never had a value stored falls back to the configured default, so the answer never distinguishes off from unset - ask GET api/2.0/ai/preferences/is-deep-mode-set for that. This is a read-only operation.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	Whether deep mode is on, falling back to the configured default when the scope has no value of its own.	Boolean	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Boolean

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiPreferencesGetReasoningLevel

AiAiReasoningLevel aiPreferencesGetReasoningLevel(entityId)

GET /api/2.0/ai/preferences/get-reasoning-level

Get reasoning level

Returns the effective extended-thinking depth of the scope: off while deep mode is off, otherwise the persisted depth (low, medium, high, max), falling back to the default depth (medium) when none has been stored. entityId picks a room and omitting it reads the portal-wide preference. Providers clamp the depth to what the model accepts.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	Success.	AiAiReasoningLevel	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiAiReasoningLevel

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiPreferencesIsDeepModeSet

Boolean aiPreferencesIsDeepModeSet(entityId)

GET /api/2.0/ai/preferences/is-deep-mode-set

Is deep mode set

Tells whether a scope has an explicitly persisted extended-thinking setting of its own, as opposed to inheriting the configured default. entityId picks a room and omitting it asks about the portal-wide preference. A true answer means a value was stored, whether that value is on or off - read the value itself with GET api/2.0/ai/preferences/get-deep-mode. This is the check a settings screen uses to show an explicit override rather than an inherited state.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	Whether the scope has a preference of its own, whichever way that preference is set.	Boolean	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Boolean

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiPreferencesSetDeepMode

AiSuccessResponse aiPreferencesSetDeepMode(aiPreferencesSetDeepMode_request)

PUT /api/2.0/ai/preferences/set-deep-mode

Set deep mode

Stores the deep-mode toggle of a scope. false stores the off depth; true keeps the depth already stored and falls back to the default depth (medium) when none is. value has to be a real boolean: a string, a number or an absent value is rejected rather than coerced, so the string false cannot silently switch the setting on and an empty request cannot silently switch it off. entityId picks a room and omitting it writes the portal-wide preference. It is idempotent, so there is no need to read the current value first.

Parameters

Name	In	Type	Description	Notes
aiPreferencesSetDeepMode_request	body	aiPreferencesSetDeepMode_request		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the preference was stored.	AiSuccessResponse	-
400	`value` is missing or is not a boolean.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiPreferencesSetReasoningLevel

AiSuccessResponse aiPreferencesSetReasoningLevel(aiPreferencesSetReasoningLevel_request)

PUT /api/2.0/ai/preferences/set-reasoning-level

Set reasoning level

Persists the extended-thinking depth of the scope as its single stored value: a depth turns deep mode on at that depth, off turns it off and replaces the stored depth (a later deep-mode true without a depth lands on medium). entityId picks a room and omitting it writes the portal-wide preference. Idempotent.

Parameters

Name	In	Type	Description	Notes
aiPreferencesSetReasoningLevel_request	body	aiPreferencesSetReasoningLevel_request		[required]

Responses

Status code	Description	Type	Response headers
200	Success.	AiSuccessResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiProfileMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

AIProfilesApi

aiProfilesCreate

AiProfileMutationResult aiProfilesCreate(AiCreateProfileInput)

POST /api/2.0/ai/profiles/create

Create a provider profile

Creates an AI provider profile - the endpoint, credentials and model that a chat round runs on - and returns it. The name has to be unique, the credentials are probed against the live provider before anything is stored, and the portal's first profile also takes the Default assignment slot. Two inputs are refused outright: a baseUrl pointing at a private network address, and providerType: external, which delegates transport to the host application and therefore cannot work for a profile the server manages. On a portal running the AI gateway, profiles are managed centrally and this operation answers 403.

Parameters

Name	In	Type	Description	Notes
AiCreateProfileInput	body	AiCreateProfileInput		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the profile was created, with it in `profile`. A refusal is reported in `error` rather than as a status.	AiProfileMutationResult	-
400	The provider URL is missing, malformed, or points at a private network address.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI profiles are read-only on this portal because they are managed by the AI gateway.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiProfilesDelete

AiSuccessResponse aiProfilesDelete(body)

DELETE /api/2.0/ai/profiles/delete

Delete a provider profile

Deletes an AI provider profile and cleans up every assignment pointing at it: the Default slot moves to the first remaining profile and the other slots are left unbound. The ID is required and may be sent in the body or as a query parameter. An unknown ID is not reported - the call answers success without deleting anything. Threads already bound to the profile keep the stored reference, so a round on such a thread falls back to whatever the scope resolves to.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the profile to delete, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the request was accepted, whether or not a profile was deleted.	AiSuccessResponse	-
400	The profile ID is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

aiProfilesGetById_200_response

HTTP request headers

Content-Type: application/json
Accept: application/json

aiProfilesGetById

aiProfilesGetById_200_response aiProfilesGetById(id)

GET /api/2.0/ai/profiles/get-by-id

Get a provider profile

Returns one AI provider profile by its ID, with its secrets stripped: neither the API key nor the custom headers are ever sent back, on any portal. The ID is required and is read from the query, and an unknown one answers 404. The baseUrl in the answer is the one that was stored, not the internal gateway address a round actually dials, so it cannot be used to reach the provider directly. Use GET api/2.0/ai/profiles/list to enumerate profiles instead of reading them one by one.

Parameters

Name	In	Type	Description	Notes
id	query	String	The AI provider profile identifier.	[required] [example: `00000000-0000-0000-0000-000000000000`]

Responses

Status code	Description	Type	Response headers
200	The profile, with its key and headers stripped.	aiProfilesGetById_200_response	-
400	The profile ID is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	No profile has this ID.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiProfilesList

List aiProfilesList()

GET /api/2.0/ai/profiles/list

List provider profiles

Lists the portal's AI provider profiles with their secrets stripped, the same way the single-profile read does. It takes no parameters and is not paginated, because a portal holds few profiles. On a portal running the AI gateway the answer is synthesised from the gateway's own catalogue rather than from stored records. The IDs in the answer are what the assignment operations and every round's profileId accept.

Parameters

This endpoint does not need any parameter.

Responses

Status code	Description	Type	Response headers
200	The portal's profiles, with their keys and headers stripped.	List	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiProfilesListModels

List aiProfilesListModels(profileId)

GET /api/2.0/ai/profiles/list-models

List models

Lists the models a stored profile's provider currently offers, asking the provider itself rather than reading a cached list. profileId is required and is read from the query. A failure is reported with the provider's own verdict: an unusable key comes back as 400 and a provider that is unreachable or broken as 502, while a missing profile or a caller without access keeps the status the portal gave it. Use POST api/2.0/ai/profiles/list-provider-models to probe an endpoint that has no profile yet.

Parameters

Name	In	Type	Description	Notes
profileId	query	String	The AI provider profile identifier.	[required] [example: `00000000-0000-0000-0000-000000000000`]

Responses

Status code	Description	Type	Response headers
200	The models the profile's provider currently offers.	List	-
400	`profileId` is missing, or the provider rejected the profile's API key.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-
502	The AI provider could not be reached, or answered with a failure of its own.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiProfilesListProviderModels

List aiProfilesListProviderModels(aiProfilesListProviderModels_request)

POST /api/2.0/ai/profiles/list-provider-models

List provider models

Lists the models an endpoint offers for credentials supplied in the request, before any profile exists - this is what a provider-setup form calls to fill its model picker. providerType and baseUrl are both required, and a 400 for either names the offending input in a field member so the form can highlight it; a baseUrl pointing at a private network address is refused as well. For providerType: onlyoffice the answer comes from the portal gateway's catalogue, which carries richer capability data than the provider's own listing and matches what GET api/2.0/ai/profiles/list reports; a portal without that gateway falls back to asking the provider. A provider that is unreachable or broken is reported as 502, and one that rejects the key as 400.

Parameters

Name	In	Type	Description	Notes
aiProfilesListProviderModels_request	body	aiProfilesListProviderModels_request		[required]

Responses

Status code	Description	Type	Response headers
200	The models the endpoint offers for the supplied credentials.	List	-
400	`baseUrl` is missing, points at a private network address, or the provider rejected the supplied API key.	aiProfilesListProviderModels_400_response	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-
502	The AI provider could not be reached, or answered with a failure of its own.	AiErrorResponse	-

Return type

Authorization

aiProfilesTestConnection_200_response

HTTP request headers

Content-Type: application/json
Accept: application/json

aiProfilesTestConnection

aiProfilesTestConnection_200_response aiProfilesTestConnection(body)

POST /api/2.0/ai/profiles/test-connection

Test a profile's provider

Probes a stored profile's credentials against its provider and reports the outcome in the answer, writing nothing - this is what a Test button calls so that a failure does not commit anything. profileId is required and may be sent in the body or as a query parameter. The result is carried in the body rather than in the status, so a failed probe still answers 200 and the caller has to read the payload. To validate credentials that are not stored yet, use POST api/2.0/ai/profiles/list-provider-models.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the profile to probe, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	The outcome of the probe. A failed probe is reported here, not as a status.	aiProfilesTestConnection_200_response	-
400	`profileId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiProfileMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

aiProfilesUpdate

AiProfileMutationResult aiProfilesUpdate(AiProfile)

PUT /api/2.0/ai/profiles/update

Update a provider profile

Replaces a stored AI provider profile and returns it, re-checking name uniqueness and probing the credentials against the live provider again. The same two inputs are refused as on create - a private-network baseUrl and providerType: external - and the whole profile is overwritten by the one supplied rather than merged. On a portal running the AI gateway this answers 403, because profiles are managed centrally there. A profile that is bound to an action or an agent keeps those bindings.

Parameters

Name	In	Type	Description	Notes
AiProfile	body	AiProfile		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the profile was updated, with the stored profile in `profile`.	AiProfileMutationResult	-
400	The provider URL is missing, malformed, or points at a private network address.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI profiles are read-only on this portal because they are managed by the AI gateway.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiPromptMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

AIPromptsApi

aiPromptsCreate

AiPromptMutationResult aiPromptsCreate(AiCreatePromptInput)

POST /api/2.0/ai/prompts/create

Save a prompt

Saves a new prompt in the caller's own prompt library and returns it. The name has to be non-empty and unique inside its folder, and folderId has to name an existing folder - omit it to save the prompt at the root. Prompts are per-user: another user's library is never visible here, and no permission beyond having AI enabled is needed. The answer carries the stored prompt including the ID to use with the update, move and delete operations.

Parameters

Name	In	Type	Description	Notes
AiCreatePromptInput	body	AiCreatePromptInput		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the prompt was saved, with it in `prompt`.	AiPromptMutationResult	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiFolderMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

aiPromptsCreateFolder

AiFolderMutationResult aiPromptsCreateFolder(body)

POST /api/2.0/ai/prompts/create-folder

Create folder

Creates a folder in the caller's prompt library and returns it. The name has to be non-empty and unique across that library. Folders do not nest: there is one flat level, so a folder cannot be created inside another. The answer carries the folder ID to use as folderId when saving or moving prompts.

Parameters

Name	In	Type	Description	Notes
body	body	String	The name of the folder to create, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	Whether the folder was created, with it in `folder`.	AiFolderMutationResult	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiPromptsDelete

AiSuccessResponse aiPromptsDelete(body)

DELETE /api/2.0/ai/prompts/delete

Delete a saved prompt

Deletes one saved prompt from the caller's library. The ID may be sent in the body or as a query parameter, and it is required. An ID that does not exist, or that belongs to another user, is not reported: the call answers success without deleting anything. The deletion is permanent.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the prompt to delete, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the request was accepted, whether or not a prompt was deleted.	AiSuccessResponse	-
400	The prompt ID is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiPromptsDeleteFolder

AiSuccessResponse aiPromptsDeleteFolder(body)

DELETE /api/2.0/ai/prompts/delete-folder

Delete folder

Deletes a folder together with every prompt inside it, permanently. The ID is required and may be sent in the body or as a query parameter. Unlike deleting a prompt, this checks first: a folder that does not exist, and one that belongs to another user, both answer 404 - the two cases are deliberately indistinguishable, so a foreign folder cannot be probed. Move the prompts out with PUT api/2.0/ai/prompts/move first if they should survive.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the folder to delete, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the folder and the prompts inside it are gone.	AiSuccessResponse	-
400	The folder ID is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	No prompt folder has this ID.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiPromptsExport

AiPromptBundle aiPromptsExport()

GET /api/2.0/ai/prompts/export

Export the prompt library

Builds a versioned bundle of every prompt and folder in the caller's library and returns it, with no parameters. The bundle is self-contained: it carries its own format version so an older export can still be read back, and it is the input POST api/2.0/ai/prompts/import-bundle expects. This is also the only way to read the whole library at once, since listing is folder-scoped. Nothing is changed by the call.

Parameters

This endpoint does not need any parameter.

Responses

Status code	Description	Type	Response headers
200	The whole library as a versioned bundle, ready to import.	AiPromptBundle	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiPromptBundle

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiPromptsGetById

AiPrompt aiPromptsGetById(id)

GET /api/2.0/ai/prompts/get-by-id

Get a saved prompt

Returns one saved prompt by its ID. The ID is required and is read from the query. An ID that is unknown, or that belongs to another user, is not reported as 404: the answer is an empty body with status 200, so treat a missing payload as no such prompt. Prompt IDs come from GET api/2.0/ai/prompts/list or from the answer of the create operation.

Parameters

Name	In	Type	Description	Notes
id	query	String	The saved prompt identifier.	[required] [example: `33333333-3333-3333-3333-333333333333`]

Responses

Status code	Description	Type	Response headers
200	The prompt, or an empty body when no prompt of the caller's has that ID.	AiPrompt	-
400	The prompt ID is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiPrompt

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiPromptsGetFolderById

AiPromptFolder aiPromptsGetFolderById(id)

GET /api/2.0/ai/prompts/get-folder-by-id

Get a prompt folder

Returns one folder of the caller's prompt library by its ID, without the prompts inside it. The ID is required and is read from the query. An unknown or foreign ID is not reported as 404: the answer is an empty body with status 200. This differs from the delete operation on the same ID, which does answer 404.

Parameters

Name	In	Type	Description	Notes
id	query	String	The prompt folder identifier.	[required] [example: `44444444-4444-4444-4444-444444444444`]

Responses

Status code	Description	Type	Response headers
200	The folder, or an empty body when no folder of the caller's has that ID.	AiPromptFolder	-
400	The folder ID is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiPromptFolder

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiPromptsImportBundle

AiImportResult aiPromptsImportBundle(aiPromptsImportBundle_request)

POST /api/2.0/ai/prompts/import-bundle

Import bundle

Writes a bundle produced by GET api/2.0/ai/prompts/export back into the caller's library. mode decides how: replace deletes the current prompts and folders before writing, and merge writes the bundle on top of what is already there. The folder references inside the bundle are validated before anything is written, so a corrupt bundle is rejected whole rather than applied halfway. replace is destructive and cannot be undone - export first if the current library matters.

Parameters

Name	In	Type	Description	Notes
aiPromptsImportBundle_request	body	aiPromptsImportBundle_request		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the bundle was written, how many prompts it imported, and what was refused.	AiImportResult	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiImportResult

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiPromptsList

List aiPromptsList(folderId)

GET /api/2.0/ai/prompts/list

List saved prompts

Lists the caller's saved prompts, newest first. folderId scopes the answer to one folder, and omitting it - or sending it empty - lists the prompts that sit at the root rather than every prompt, because the client fetcher cannot tell an absent value from a null one. There is therefore no way to ask for the whole library in one call: walk the folders from GET api/2.0/ai/prompts/list-folders, or take everything at once with GET api/2.0/ai/prompts/export. The prompts of other users are never included.

Parameters

Name	In	Type	Description	Notes
folderId	query	String	The prompt folder identifier. Omit to list the prompts that sit outside any folder.	[optional] [example: `44444444-4444-4444-4444-444444444444`]

Responses

Status code	Description	Type	Response headers
200	The prompts of the scope, newest first.	List	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiPromptsListFolders

List aiPromptsListFolders()

GET /api/2.0/ai/prompts/list-folders

List folders

Lists every folder of the caller's prompt library, newest first, with no parameters and no pagination. Folders are flat, so the answer is a single list rather than a tree. The prompts inside them are not included - read those with GET api/2.0/ai/prompts/list per folder. Another user's folders are never listed.

Parameters

This endpoint does not need any parameter.

Responses

Status code	Description	Type	Response headers
200	Every folder of the caller's library, newest first.	List	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiPromptMutationResult

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiPromptsMove

AiPromptMutationResult aiPromptsMove(aiPromptsMove_request)

PUT /api/2.0/ai/prompts/move

Move a prompt to a folder

Moves a saved prompt into another folder, or to the root when folderId is omitted or null. The name is re-validated in the target folder, so the move fails when a prompt of that name already sits there - rename it first with PUT api/2.0/ai/prompts/update. Nothing about the prompt other than its folder changes. The answer carries the moved prompt.

Parameters

Name	In	Type	Description	Notes
aiPromptsMove_request	body	aiPromptsMove_request		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the prompt was moved, with the moved prompt in `prompt`.	AiPromptMutationResult	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiFolderMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

aiPromptsRenameFolder

AiFolderMutationResult aiPromptsRenameFolder(aiPromptsRenameFolder_request)

PUT /api/2.0/ai/prompts/rename-folder

Rename folder

Renames a folder in the caller's prompt library, validating the new name against the folders already there. The prompts inside it are untouched and keep their IDs. The answer carries the renamed folder. A name that another folder already uses is rejected.

Parameters

Name	In	Type	Description	Notes
aiPromptsRenameFolder_request	body	aiPromptsRenameFolder_request		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the folder was renamed, with the stored folder in `folder`.	AiFolderMutationResult	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiPromptMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

aiPromptsUpdate

AiPromptMutationResult aiPromptsUpdate(aiPromptsUpdate_request)

PUT /api/2.0/ai/prompts/update

Update a saved prompt

Changes a saved prompt and returns the stored result. Only the fields present in updates are written, so a partial object leaves the rest of the prompt alone. The name and the folder reference are re-validated whenever either changes, which means an update can fail on a name another prompt in the same folder already uses. Use PUT api/2.0/ai/prompts/move to change only the folder.

Parameters

Name	In	Type	Description	Notes
aiPromptsUpdate_request	body	aiPromptsUpdate_request		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the prompt was updated, with the stored prompt in `prompt`.	AiPromptMutationResult	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

AISettingsApi

aiSettingsGet

AiAiSettingsWrapper aiSettingsGet()

GET /api/2.0/ai/config

Get AI settings

Reports the portal's AI configuration and whether AI is usable at all, which is the first call a client makes before offering any AI feature. It takes no parameters and is proxied unchanged to the DocSpace AI service, so the answer is that service's settings payload. Among other things it says whether the portal runs on the central AI gateway, which decides whether provider profiles can be edited here at all. This is a read-only operation.

Parameters

This endpoint does not need any parameter.

Responses

Status code	Description	Type	Response headers
200	The portal's AI configuration and whether AI is usable at all.	AiAiSettingsWrapper	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiAiSettingsWrapper

Authorization

AiAiUserSettingsWrapper

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiSettingsGetUser

AiAiUserSettingsWrapper aiSettingsGetUser()

GET /api/2.0/ai/config/user

Get user AI settings

Returns the AI settings of the calling user, as opposed to the portal-wide ones. It takes no parameters - the user is the authenticated caller, and there is no way to read somebody else's settings - and is proxied unchanged to the DocSpace AI service. Use GET api/2.0/ai/config for the portal-wide configuration. This is a read-only operation.

Parameters

This endpoint does not need any parameter.

Responses

Status code	Description	Type	Response headers
200	The calling user's AI settings.	AiAiUserSettingsWrapper	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiVectorizationSettingsWrapper

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiSettingsGetVectorization

AiVectorizationSettingsWrapper aiSettingsGetVectorization()

GET /api/2.0/ai/config/vectorization

Get vectorization settings

Returns the portal's vectorization settings - the embedding provider and the options used when portal content is indexed for retrieval. It takes no parameters and is proxied unchanged to the DocSpace AI service. Vectorization is a portal-wide setting, so there is no room-scoped form of it. Change it with PUT api/2.0/ai/config/vectorization.

Parameters

This endpoint does not need any parameter.

Responses

Status code	Description	Type	Response headers
200	The portal's vectorization settings.	AiVectorizationSettingsWrapper	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiAiUserSettingsWrapper

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiSettingsSetUser

AiAiUserSettingsWrapper aiSettingsSetUser(request_body)

PUT /api/2.0/ai/config/user

Update user AI settings

Replaces the AI settings of the calling user and returns the stored result. The body is proxied unchanged to the DocSpace AI service, which validates it, so a rejected value comes back with that service's verdict. Only the caller's own settings can be written. Portal-wide configuration is not touched by this operation.

Parameters

Name	In	Type	Description	Notes
request_body	body	Map	The user's AI settings, proxied unchanged to the DocSpace AI service, which owns and validates the shape. Read the current one with `GET api/2.0/ai/config/user` and send it back changed.	[required]

Responses

Status code	Description	Type	Response headers
200	The calling user's stored AI settings.	AiAiUserSettingsWrapper	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiVectorizationSettingsWrapper

HTTP request headers

Content-Type: application/json
Accept: application/json

aiSettingsSetVectorization

AiVectorizationSettingsWrapper aiSettingsSetVectorization(request_body)

PUT /api/2.0/ai/config/vectorization

Update vectorization settings

Replaces the portal's vectorization settings and returns the stored result. The body is proxied unchanged to the DocSpace AI service, which validates it, so a rejected value is reported with that service's own verdict rather than being checked here. Changing the embedding provider does not re-index anything already indexed - start that separately with POST api/2.0/ai/vectorization/tasks. This is a portal-wide setting and requires the permissions the AI service demands for it.

Parameters

Name	In	Type	Description	Notes
request_body	body	Map	The portal's vectorization settings, proxied unchanged to the DocSpace AI service, which owns and validates the shape. Read the current one with `GET api/2.0/ai/config/vectorization` and send it back changed.	[required]

Responses

Status code	Description	Type	Response headers
200	The stored vectorization settings.	AiVectorizationSettingsWrapper	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

aiThreadsAppendUserMessage_200_response

HTTP request headers

Content-Type: application/json
Accept: application/json

AIThreadsApi

aiThreadsAppendUserMessage

aiThreadsAppendUserMessage_200_response aiThreadsAppendUserMessage(aiThreadsAppendUserMessage_request)

POST /api/2.0/ai/threads/append-user-message

Append user message

Stores a user message in a thread and bumps its last-edit date so the thread resurfaces at the top of the list. The per-kind attachment cap of the composer is enforced here as well, so a direct API call cannot exceed what the UI allows. Passing profileId rebinds the thread to another model, which is how a mid-conversation model switch is recorded. The answer carries the new message's ID; the message is stored as sent and no reply is generated - run a round with POST api/2.0/ai/ai/send-with-stream for that.

Parameters

Name	In	Type	Description	Notes
aiThreadsAppendUserMessage_request	body	aiThreadsAppendUserMessage_request		[required]

Responses

Status code	Description	Type	Response headers
200	The stored message, with the ID storage assigned to it.	aiThreadsAppendUserMessage_200_response	-
400	The message is longer than the limit allows.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiThreadsClearMessages

AiSuccessResponse aiThreadsClearMessages(body)

DELETE /api/2.0/ai/threads/clear-messages

Clear messages

Removes every message of a thread while keeping the thread, its title and its model binding, and bumps its last-edit date. The messages are gone for good. Unlike delete this does not verify that the thread exists, so clearing an unknown threadId reports success rather than 404. The answer only confirms the write.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the thread to empty, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the request was accepted. It does not mean the thread existed.	AiSuccessResponse	-
400	`threadId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiThreadsCreate

AiThread aiThreadsCreate(aiThreadsCreate_request)

POST /api/2.0/ai/threads/create

Create a chat thread

Creates a chat thread with a title supplied by the caller and returns it. A scoped thread requires that entityId names a room the caller can open, and a model has to resolve for the scope - an explicit profileId, or the room's Chat assignment - otherwise there is nothing to run the thread against and the call answers 404. In an agent room the agent's own assignment overrides any profileId sent with the request, so a thread there always starts on the agent's model. Use POST api/2.0/ai/threads/open-or-create instead when the title should be generated from the first user message.

Parameters

Name	In	Type	Description	Notes
aiThreadsCreate_request	body	aiThreadsCreate_request		[required]

Responses

Status code	Description	Type	Response headers
200	The created thread.	AiThread	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The `entityId` names a room the caller cannot open, or no live AI profile is bound to it, so there is no model to run the thread against.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiThread

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiThreadsDelete

AiSuccessResponse aiThreadsDelete(body)

DELETE /api/2.0/ai/threads/delete

Delete a chat thread

Deletes a thread together with every message in it. The thread has to exist: unlike the other operations that take a threadId, this one checks first and answers 404 for an unknown or already-deleted thread rather than reporting success. The deletion is permanent and the messages cannot be recovered. To empty a thread but keep it, use DELETE api/2.0/ai/threads/clear-messages.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the thread to delete, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the thread and its messages are gone.	AiSuccessResponse	-
400	`threadId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	No thread has this ID.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiThreadsDeleteMessage

AiSuccessResponse aiThreadsDeleteMessage(body)

DELETE /api/2.0/ai/threads/delete-message

Delete message

Deletes one message and leaves the rest of the thread untouched. messageId is required and may be sent either in the body or as a query parameter. An unknown ID is not reported: the call answers success without having deleted anything, so verify with GET api/2.0/ai/threads/read-messages when it matters. The deletion is permanent.

Parameters

Name	In	Type	Description	Notes
body	body	String	The ID of the message to delete, as a bare JSON string.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the request was accepted, whether or not a message was deleted.	AiSuccessResponse	-
400	`messageId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiThreadsGetById

AiThread aiThreadsGetById(threadId)

GET /api/2.0/ai/threads/get-by-id

Get a chat thread

Returns one thread by its ID, without its messages - read those with GET api/2.0/ai/threads/read-messages. threadId is required and an unknown one answers 404, so the result is never an empty body. The answer carries the thread's title, its model binding and its last-edit date. This is a read-only operation and does not bump that date.

Parameters

Name	In	Type	Description	Notes
threadId	query	String	The chat thread identifier.	[required] [example: `11111111-1111-1111-1111-111111111111`]

Responses

Status code	Description	Type	Response headers
200	The thread, without its messages.	AiThread	-
400	`threadId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	No thread has this ID.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiThread

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiThreadsGetMessageById

AiThreadMessageLike aiThreadsGetMessageById(messageId)

GET /api/2.0/ai/threads/get-message-by-id

Get one chat message

Returns one message by its ID, wherever it sits, without needing the thread it belongs to. messageId is required. Unlike GET api/2.0/ai/threads/get-by-id an unknown ID is not reported as 404: the answer is an empty body with status 200, so a client has to treat a missing payload as no such message. Message IDs come from the thread history or from the answer of POST api/2.0/ai/threads/append-user-message.

Parameters

Name	In	Type	Description	Notes
messageId	query	String	The globally unique chat message identifier.	[required] [example: `22222222-2222-2222-2222-222222222222`]

Responses

Status code	Description	Type	Response headers
200	The message, or an empty body when no message has that ID.	AiThreadMessageLike	-
400	`messageId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiThreadMessageLike

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiThreadsList

List aiThreadsList(entityId, count, cursor, query)

GET /api/2.0/ai/threads/list

List chat threads

Lists the threads of a scope, most recently edited first, and searches their titles case-insensitively when query is given. Every parameter is optional: omitting entityId lists the global scope, and omitting count lets the engine apply its own page size. Pagination is by cursor, and the cursor is a JSON object passed as a string in the query - {id: <last thread id>, lastEditDate: <its date>} - taken from the last entry of the previous page. A cursor that is not valid JSON, or that lacks an id, is ignored rather than rejected, and the read silently starts from the first page again.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]
count	query	Integer	The maximum number of items to return in one page.	[optional] [example: `20`]
cursor	query	String	The keyset pagination cursor: the JSON-encoded sort key of the last item already received. Omit for the first page.	[optional] [example: `{"id":"11111111-1111-1111-1111-111111111111","lastEditDate":1767225600000}`]
query	query	String	The full-text query the thread list is filtered by.	[optional] [example: `contract`]

Responses

Status code	Description	Type	Response headers
200	The threads of the scope, most recently edited first.	List	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiThreadsOpenOrCreate

AiOpenOrCreateResult aiThreadsOpenOrCreate(aiThreadsOpenOrCreate_request)

POST /api/2.0/ai/threads/open-or-create

Open or create

Opens a chat thread and returns it with its history, or creates one whose title is generated from the first message supplied in the request. That first message is not persisted: follow up with POST api/2.0/ai/threads/append-user-message to store it, or start the round directly with POST api/2.0/ai/ai/send-with-stream. Unlike create this takes a whole resolved profile object rather than an ID, and a request without one answers 404 because no model could be bound. A supplied entityId has to be a room the caller can open; anything that is not an agent room folds to the global scope instead of being rejected.

Parameters

Name	In	Type	Description	Notes
aiThreadsOpenOrCreate_request	body	aiThreadsOpenOrCreate_request		[required]

Responses

Status code	Description	Type	Response headers
200	The thread that was opened or created, with its prior messages. A created one carries the generated title.	AiOpenOrCreateResult	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The `entityId` names a room the caller cannot open, or no live AI profile is bound to it.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiOpenOrCreateResult

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiThreadsReadMessages

List aiThreadsReadMessages(threadId, count, cursor, direction)

GET /api/2.0/ai/threads/read-messages

Read messages

Reads the messages of one thread, oldest first, with the same string-encoded JSON cursor as the thread list. direction turns the read around, and only the exact value desc does so - anything else, including a misspelling, reads forward. Omitting threadId is not an error: the call answers 200 with an empty list, so an empty result does not distinguish a thread with no messages from a request that forgot the ID. A malformed cursor is ignored and the read starts from the beginning.

Parameters

Name	In	Type	Description	Notes
threadId	query	String	The chat thread identifier.	[required] [example: `11111111-1111-1111-1111-111111111111`]
count	query	Integer	The maximum number of items to return in one page.	[optional] [example: `20`]
cursor	query	String	The keyset pagination cursor: the JSON-encoded sort key of the last item already received. Omit for the first page.	[optional] [example: `{"id":"11111111-1111-1111-1111-111111111111","lastEditDate":1767225600000}`]
direction	query	String	The order the message page is read in. Only desc turns the read around and pages back from the newest message; omit for the forward read.	[optional] [example: `desc`]

Responses

Status code	Description	Type	Response headers
200	The thread's messages, oldest first unless `direction` reversed them. An empty list also means the request carried no thread ID.	List	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

aiThreadsRegenerateTitle_200_response

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiThreadsRegenerateTitle

aiThreadsRegenerateTitle_200_response aiThreadsRegenerateTitle(aiThreadsRegenerateTitle_request)

POST /api/2.0/ai/threads/regenerate-title

Regenerate title

Asks the model to produce a title from the thread's first user message, stores it, and returns the new title. Both threadId and a resolved profile object are required; a thread with no user message yet has nothing to title and fails. This costs a model call, unlike POST api/2.0/ai/threads/rename, which just stores the string it is given. An entityMeta sent with the request is only read for its entityId hint - the source itself is resolved server-side under the caller's credentials, so a client cannot attribute the call to somebody else's room.

Parameters

Name	In	Type	Description	Notes
aiThreadsRegenerateTitle_request	body	aiThreadsRegenerateTitle_request		[required]

Responses

Status code	Description	Type	Response headers
200	The newly generated title, already stored on the thread.	aiThreadsRegenerateTitle_200_response	-
400	`threadId` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiThreadsRename

AiSuccessResponse aiThreadsRename(aiThreadsRename_request)

PUT /api/2.0/ai/threads/rename

Rename a chat thread

Replaces a thread's title with the one supplied and bumps its last-edit date. Both threadId and a title with at least one non-whitespace character are required - a blank title is rejected rather than silently stored, so a thread cannot end up nameless. The answer only confirms the write. To have the model produce a title instead of supplying one, use POST api/2.0/ai/threads/regenerate-title.

Parameters

Name	In	Type	Description	Notes
aiThreadsRename_request	body	aiThreadsRename_request		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the new title was stored.	AiSuccessResponse	-
400	`threadId` or the new title is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiThreadsTouch

AiSuccessResponse aiThreadsTouch(aiThreadsTouch_request)

POST /api/2.0/ai/threads/touch

Bump a thread's activity

Bumps a thread's last-edit date without adding a message, which resurfaces it in the list. Passing profileId also rebinds the thread to another model, so this is the operation to call when a model switch alone should count as activity. Nothing else about the thread changes and the answer only confirms the write. It is idempotent: repeating it simply moves the date forward again.

Parameters

Name	In	Type	Description	Notes
aiThreadsTouch_request	body	aiThreadsTouch_request		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the thread's activity date moved forward.	AiSuccessResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiThreadsUpdateMessage

AiSuccessResponse aiThreadsUpdateMessage(aiThreadsUpdateMessage_request)

PUT /api/2.0/ai/threads/update-message

Update message

Replaces the content of one stored message, which is how the edit and regenerate flows change a message outside the streaming lifecycle. The whole message is overwritten by the one supplied rather than merged, so send a complete object. Neither the ID nor the payload is validated here, so a malformed request surfaces as an error relayed from storage rather than as a 400. The answer only confirms the write.

Parameters

Name	In	Type	Description	Notes
aiThreadsUpdateMessage_request	body	aiThreadsUpdateMessage_request		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the replacement was stored.	AiSuccessResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiToolsMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

AIToolsApi

aiToolsAddCustomServer

AiToolsMutationResult aiToolsAddCustomServer(aiToolsAddCustomServer_request)

POST /api/2.0/ai/tools/add-custom-server

Add custom server

Registers a custom MCP server under the given name so the model may call its tools. The name becomes a URL path segment, so it may not be ., .., or contain a path separator or a control character. config may be omitted in two cases: a name matching a host-configured system server pins the entry to that server's canonical settings as a whitelist marker, and a name already registered portal-wide copies the portal-level configuration into this scope; anything else without a config is rejected. entityId scopes the registration and has to name a room the caller can open - a room that is not an agent room folds to the portal-wide scope, while an unreachable one is refused so it cannot silently rewrite the portal's own registry.

Parameters

Name	In	Type	Description	Notes
aiToolsAddCustomServer_request	body	aiToolsAddCustomServer_request		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the server was registered, with the stored entry.	AiToolsMutationResult	-
400	The server name is missing or is not routable.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiToolsGetAllowAlways

List aiToolsGetAllowAlways(entityId)

GET /api/2.0/ai/tools/get-allow-always

Get allow always

Returns the always-allow list of the scope - the tools whose calls run without pausing the round for approval. entityId picks the scope and omitting it reads the portal-wide setting. An empty answer means every tool call has to be approved through POST api/2.0/ai/ai/approve-tool-call. Use GET api/2.0/ai/tools/is-allow-always to ask about a single tool.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The tools that run without an approval pause. An empty list means every call needs approval.	List	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

List

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiToolsGetCustomServer

Object aiToolsGetCustomServer(name, entityId)

GET /api/2.0/ai/tools/get-custom-server

Get custom server

Returns the stored configuration of one registered custom MCP server. The name is required and is read from the query; entityId picks the scope, and omitting it reads the portal-wide registry. A name that is not registered answers a null body with status 200 rather than 404. The configuration of a system server is returned empty on purpose: those run server-side only, so neither their endpoint nor their credentials are handed to a browser.

Parameters

Name	In	Type	Description	Notes
name	query	String	The custom MCP server name.	[required] [example: `acme-mcp`]
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The stored configuration, empty for a system server and null when the name is not registered.	Object	-
400	The server name is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Object

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiToolsGetDisabled

Map aiToolsGetDisabled(entityId)

GET /api/2.0/ai/tools/get-disabled

Get disabled

Returns the tools switched off in the scope, as a map of server type to tool names. entityId picks the scope and omitting it reads the portal-wide setting. An absent server type means nothing is switched off for it, so an empty answer means every tool is on offer. Use GET api/2.0/ai/tools/is-tool-disabled to ask about one tool instead of reading the whole map.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The switched-off tools as a map of server type to tool names. An absent type means nothing is switched off for it.	Map	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Map

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiToolsIsAllowAlways

Boolean aiToolsIsAllowAlways(serverType, toolName, entityId)

GET /api/2.0/ai/tools/is-allow-always

Is allow always

Tells whether one named tool runs without an approval pause in the scope. Both serverType and toolName are required and are read from the query; entityId picks the scope. The answer is a bare boolean. A false answer means a call to that tool pauses the round, and the caller resumes it with the approve or deny operation.

Parameters

Name	In	Type	Description	Notes
serverType	query	String	The MCP server type the tool belongs to.	[required] [example: `docspace`]
toolName	query	String	The tool name.	[required] [example: `docspace_get_folder`]
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	Whether that one tool runs without an approval pause.	Boolean	-
400	`serverType` or `toolName` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Boolean

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiToolsIsToolDisabled

Boolean aiToolsIsToolDisabled(serverType, toolName, entityId)

GET /api/2.0/ai/tools/is-tool-disabled

Is tool disabled

Tells whether one named tool of one server type is switched off in the scope. Both serverType and toolName are required and are read from the query; entityId picks the scope. The answer is a bare boolean. It reflects only the disable list - a tool that is on offer may still require approval, which GET api/2.0/ai/tools/is-allow-always reports.

Parameters

Name	In	Type	Description	Notes
serverType	query	String	The MCP server type the tool belongs to.	[required] [example: `docspace`]
toolName	query	String	The tool name.	[required] [example: `docspace_get_folder`]
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	Whether that one tool is switched off in the scope.	Boolean	-
400	`serverType` or `toolName` is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Boolean

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiToolsListCustomServers

Map aiToolsListCustomServers(entityId)

GET /api/2.0/ai/tools/list-custom-servers

List custom servers

Lists the custom MCP servers registered in the scope as a map of name to configuration. entityId picks the scope and omitting it lists the portal-wide registry. The configuration of any entry that names a host-configured system server comes back empty, for the same reason as in the single-server read, and the portal's own built-in MCP server is left out of the list entirely because it is always enabled and cannot be configured. The names in the answer are what the disable and always-allow operations accept as serverType.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The scope's registrations as a map of name to configuration, system entries emptied and the portal's built-in server left out.	Map	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Map

Authorization

aiToolsListSystemTools_200_response

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiToolsListSystemTools

aiToolsListSystemTools_200_response aiToolsListSystemTools(entityId)

GET /api/2.0/ai/tools/list-system-tools

List system tools

Lists every tool the scope can offer the model, as a map of server type to tool group. The answer merges two sources - the host-configured system servers and the live tools of the scope's registered custom MCP servers - and names the system ones separately in system, so a client can tell the two apart. errors carries the reason a registered server delivered no tools, which is the text to show on a permission card, because the browser cannot reach a server-executed MCP server to find out for itself. The connections are opened server-side, so one request is enough and the client never speaks MCP itself; the portal's own built-in server is left out because it is always enabled.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The scope's tools grouped by server type, the system group keys named in `system`, and the reason a registered server delivered none in `errors`.	aiToolsListSystemTools_200_response	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiToolsRemoveCustomServer

AiSuccessResponse aiToolsRemoveCustomServer(aiToolsRemoveCustomServer_request)

DELETE /api/2.0/ai/tools/remove-custom-server

Remove custom server

Unregisters a custom MCP server from the scope, so the model is no longer offered its tools. The name is required and may be sent in the body or as a query parameter, and entityId has to name a room the caller can open. A name that is not registered is not reported: the call answers success without removing anything. The server itself is untouched - only this portal's registration is dropped.

Parameters

Name	In	Type	Description	Notes
aiToolsRemoveCustomServer_request	body	aiToolsRemoveCustomServer_request		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the request was accepted, whether or not a registration was removed.	AiSuccessResponse	-
400	The server name is missing.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiToolsReplaceAllCustomServers

AiToolsBulkResult aiToolsReplaceAllCustomServers(aiToolsReplaceAllCustomServers_request)

PUT /api/2.0/ai/tools/replace-all-custom-servers

Replace all custom servers

Replaces the whole custom MCP server registry of the scope with the supplied map in one write, which makes it the operation a settings screen saves with. map is required: without it the registry would be emptied, so a missing or non-object value is rejected rather than treated as none. Every name in the map is validated as a routable path segment and every configuration is resolved before anything is written, so a map with one bad entry changes nothing. entityId has to name a room the caller can open - this is the operation where an unreachable one would otherwise have wiped the portal-wide registry.

Parameters

Name	In	Type	Description	Notes
aiToolsReplaceAllCustomServers_request	body	aiToolsReplaceAllCustomServers_request		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the registry was replaced, with `errors` listing what was refused.	AiToolsBulkResult	-
400	The body is not a map of server name to configuration, or a name is not routable.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiToolsBulkResult

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiToolsSetAllowAlways

AiSuccessResponse aiToolsSetAllowAlways(aiToolsSetAllowAlways_request)

PUT /api/2.0/ai/tools/set-allow-always

Set allow always

Adds one tool to the scope's always-allow list, or takes it off, which decides whether a call to it pauses the round for approval. value is coerced to a boolean, so any truthy value adds and any falsy one removes. Unlike the disable operation, serverType is not validated here: an unknown one is stored and then simply never matches, so a wrong value fails silently. entityId has to name a room the caller can open.

Parameters

Name	In	Type	Description	Notes
aiToolsSetAllowAlways_request	body	aiToolsSetAllowAlways_request		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the always-allow list was updated.	AiSuccessResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiToolsSetDisabled

AiSuccessResponse aiToolsSetDisabled(aiToolsSetDisabled_request)

PUT /api/2.0/ai/tools/set-disabled

Set disabled

Switches off the listed tools of one server type in the scope, so the model is no longer offered them. serverType has to be a key the round's tool filter actually matches - a host-configured system server, one of the two DocSpace integration groups, web search, image generation, or one of the scope's registered custom servers - and an unknown value is rejected with the list of valid ones in the message, rather than stored and silently ignored. toolNames replaces the previous selection for that server type, so send the full list and pass an empty one to switch everything back on. entityId has to name a room the caller can open.

Parameters

Name	In	Type	Description	Notes
aiToolsSetDisabled_request	body	aiToolsSetDisabled_request		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the new disable list was stored for that server type.	AiSuccessResponse	-
400	The list of tools to disable is malformed.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiToolsMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

aiToolsUpdateCustomServer

AiToolsMutationResult aiToolsUpdateCustomServer(aiToolsUpdateCustomServer_request)

PUT /api/2.0/ai/tools/update-custom-server

Update custom server

Replaces the stored configuration of a registered custom MCP server, under the same name and scope rules as the add operation. The name is re-validated as a routable path segment, and an omitted config resolves the same way - to a system server's canonical settings, or to the portal-level entry of that name. entityId has to name a room the caller can open. The answer carries the stored registry entry.

Parameters

Name	In	Type	Description	Notes
aiToolsUpdateCustomServer_request	body	aiToolsUpdateCustomServer_request		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the server was updated, with the stored entry.	AiToolsMutationResult	-
400	The server name is missing or is not routable.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

aiVectorizationStartTask_200_response

HTTP request headers

Content-Type: application/json
Accept: application/json

AIVectorizationApi

aiVectorizationStartTask

aiVectorizationStartTask_200_response aiVectorizationStartTask(aiVectorizationStartTask_request)

POST /api/2.0/ai/vectorization/tasks

Start a vectorization task

Queues the indexing of the portal files named in the body so their contents can be retrieved during a chat round. The body is proxied unchanged to the DocSpace AI service, which validates it and owns the job. Indexing is asynchronous and fire-and-forget: the answer acknowledges the request without carrying a job handle, so there is nothing to poll and progress is not reported here. The embedding provider used is the one in GET api/2.0/ai/config/vectorization, and changing that setting does not re-index anything already indexed - queue it again for that.

Parameters

Name	In	Type	Description	Notes
aiVectorizationStartTask_request	body	aiVectorizationStartTask_request	The files to index, proxied unchanged to the DocSpace AI service, which owns and validates the shape.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the indexing was queued. It carries no job handle, so there is nothing to poll.	aiVectorizationStartTask_200_response	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

AIWebSearchApi

aiWebSearchClear

AiSuccessResponse aiWebSearchClear(body)

DELETE /api/2.0/ai/web-search/clear

Clear the web-search configuration

Removes the portal's web-search configuration, after which web search is unavailable everywhere it was not configured separately. This is not scoped: it takes no entityId and any body sent with it is ignored, so it cannot be used to clear one room's configuration. Clearing an already-unconfigured portal is not an error and the call answers success either way. The stored provider key is destroyed with the configuration and has to be entered again.

Parameters

Name	In	Type	Description	Notes
body	body	String	Ignored. The operation always clears the portal-wide configuration, so send an empty body; a value here does not scope it to a room.	[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the portal has no web-search configuration any more.	AiSuccessResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

AiWebSearchMutationResult

HTTP request headers

Content-Type: application/json
Accept: application/json

aiWebSearchConfigure

AiWebSearchMutationResult aiWebSearchConfigure(aiWebSearchConfigure_request)

PUT /api/2.0/ai/web-search/configure

Configure and verify web search

Validates a web-search configuration against the live provider and stores it only if the provider answers, which makes it the safe way to save a form in one step. entityId scopes the configuration to a room and has to name one the caller can open; omitting it configures the portal. A baseUrl pointing at a private network address is refused. Use PUT api/2.0/ai/web-search/set-active-config when the configuration should be stored without a provider round trip.

Parameters

Name	In	Type	Description	Notes
aiWebSearchConfigure_request	body	aiWebSearchConfigure_request		[required]

Responses

Status code	Description	Type	Response headers
200	Whether the configuration was stored, after the provider answered.	AiWebSearchMutationResult	-
400	The provider URL is missing, malformed, or points at a private network address.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiWebSearchGetActiveConfig

AiWebSearchConfig aiWebSearchGetActiveConfig(entityId)

GET /api/2.0/ai/web-search/get-active-config

Get active config

Returns the web-search configuration in force for a scope - the provider, its endpoint and its settings. entityId picks a room and has to name one the caller can open; omitting it reads the portal-wide configuration, and a room with none of its own falls back to that. An unconfigured scope answers an empty result rather than 404. The provider key is not part of the answer, so a client cannot read it back after storing it.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	The configuration in force for the scope, without the provider key, or an empty result when web search is not configured.	AiWebSearchConfig	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

AiWebSearchConfig

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiWebSearchIsConfigured

Boolean aiWebSearchIsConfigured(entityId)

GET /api/2.0/ai/web-search/is-configured

Is configured

Tells whether web search is available in a scope, as a bare boolean, which is the cheap check for hiding or showing the feature. entityId picks a room and has to name one the caller can open. It reports the same state as GET api/2.0/ai/web-search/get-active-config without transferring the configuration itself. A true answer means a provider is stored, not that the provider is currently reachable - probe that with POST api/2.0/ai/web-search/test-connection.

Parameters

Name	In	Type	Description	Notes
entityId	query	String	The DocSpace entity the request is scoped to - the room, folder or agent workspace the chat is invoked from. Omit for the portal-wide scope.	[optional] [example: `1234`]

Responses

Status code	Description	Type	Response headers
200	Whether a web-search provider is stored for the scope.	Boolean	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Boolean

Authorization

HTTP request headers

Content-Type: Not defined
Accept: application/json

aiWebSearchPassthroughContents

Map aiWebSearchPassthroughContents(request_body)

POST /api/2.0/ai/websearch/v1/contents

Web page contents passthrough

Fetches the contents of web pages on behalf of the document editor's AI plugin, against the portal's active web-search provider, exactly as the search passthrough does — including the entityId / entityKind billing attribution. The portal-wide configuration is used and a portal without one answers 404. The provider's status, body and content type are relayed verbatim, so its 429 and its failures surface unchanged. This is the follow-up to POST api/2.0/ai/websearch/v1/search, which returns the results whose contents this operation retrieves.

Parameters

Name	In	Type	Description	Notes
request_body	body	Map	A page-contents request in the shape the portal's active web-search provider expects, forwarded to it unchanged. The endpoint and the key come from the stored configuration.	[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, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	Web search is not configured for this portal.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
429	Relayed verbatim from the AI provider, which is rate-limiting this portal's key.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-
502	The AI provider could not be reached, or answered with a failure of its own.	AiErrorResponse	-

Return type

Map

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiWebSearchPassthroughSearch

Map aiWebSearchPassthroughSearch(request_body)

POST /api/2.0/ai/websearch/v1/search

Web search passthrough

Runs a web search on behalf of the document editor's AI plugin, which holds only a placeholder configuration - the portal's active provider and its key are resolved here, so neither ever reaches the browser. The portal-wide configuration is used, and a portal without one answers 404. The entityId and entityKind query parameters name the document the search is billed to; with the ONLYOFFICE provider the entry is resolved under the caller's credentials and sent to the gateway as the request metadata (source_id / source_type / source_title), and an entry the caller cannot open sends none. The provider's own status, body and content type are relayed as they stand, so a provider that rate-limits answers 429 and one that is unreachable answers 502. Closing the connection aborts the upstream request.

Parameters

Name	In	Type	Description	Notes
request_body	body	Map	A search request in the shape the portal's active web-search provider expects, forwarded to it unchanged. The endpoint and the key come from the stored configuration 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, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	Web search is not configured for this portal.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
429	Relayed verbatim from the AI provider, which is rate-limiting this portal's key.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-
502	The AI provider could not be reached, or answered with a failure of its own.	AiErrorResponse	-

Return type

Map

Authorization

HTTP request headers

Content-Type: application/json
Accept: application/json

aiWebSearchSetActiveConfig

AiSuccessResponse aiWebSearchSetActiveConfig(aiWebSearchConfigure_request)

PUT /api/2.0/ai/web-search/set-active-config

Set active config

Stores a web-search configuration without contacting the provider first, for a form that has already validated its input or for restoring a known-good configuration. entityId scopes it to a room and has to name one the caller can open. A baseUrl pointing at a private network address is still refused, because that check is local. Nothing guarantees the stored provider works: follow up with POST api/2.0/ai/web-search/test-connection, or use PUT api/2.0/ai/web-search/configure to have the store gated on a live probe.

Parameters

Name	In	Type	Description	Notes
aiWebSearchConfigure_request	body	aiWebSearchConfigure_request		[required]

Responses

Status code	Description	Type	Response headers
200	Confirms the configuration was stored, unverified.	AiSuccessResponse	-
400	The provider URL is missing, malformed, or points at a private network address.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
404	The referenced object does not exist, or the caller cannot access it - the two are deliberately indistinguishable, so a room the caller may not open answers 404 rather than 403.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization

aiProfilesTestConnection_200_response

HTTP request headers

Content-Type: application/json
Accept: application/json

aiWebSearchTestConnection

aiProfilesTestConnection_200_response aiWebSearchTestConnection(AiWebSearchConfig)

POST /api/2.0/ai/web-search/test-connection

Test a web-search provider

Probes a web-search configuration against the live provider and reports the outcome, storing nothing - this is what a Test button calls so that a failure commits no state. The configuration is taken from the request rather than from storage, so credentials that were never saved can be checked. A baseUrl pointing at a private network address is refused before any request leaves the portal. The verdict is carried in the body rather than in the status, so a failed probe still answers 200 and the caller has to read the payload.

Parameters

Name	In	Type	Description	Notes
AiWebSearchConfig	body	AiWebSearchConfig		[required]

Responses

Status code	Description	Type	Response headers
200	The outcome of the probe. A failed probe is reported here, not as a status.	aiProfilesTestConnection_200_response	-
400	The provider URL is missing, malformed, or points at a private network address.	AiErrorResponse	-
401	Missing `asc_auth_key` cookie or `Authorization` header.	AiErrorResponse	-
403	AI is disabled for this portal, or the caller is a guest. Relayed from the DocSpace AI service.	AiErrorResponse	-
413	The request body is larger than 100 KB, the JSON parser's limit on this route.	AiErrorResponse	-
500	Unhandled failure. The reason is logged server-side and never echoed back.	AiErrorResponse	-

Return type

Authorization