Skip to main content

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​

NameInTypeDescriptionNotes
actionTypequeryStringThe AI action the request applies to - one of Default, Chat, Code, Summarization, Translation, TextAnalyze, ImageGeneration, OCR, Vision, FormAnalysis.[required] [example: Chat]

Responses​

Status codeDescriptionTypeResponse headers
200The profile bound to the action, or an empty result when it has none of its own.String-
400actionType is missing.AiErrorResponse-
401Missing asc_auth_key cookie or Authorization header.AiErrorResponse-
403AI is disabled for this portal, the caller is a guest, or the room named by entityId is one the caller cannot open. Relayed from the DocSpace AI service or the Files API.AiErrorResponse-
500Unhandled failure. The reason is logged server-side and never echoed back.AiErrorResponse-

Return type​

String

Authorization​

cookieAuth, bearerAuth

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json