aiVectorizationStartTask
aiVectorizationStartTask_200_response aiVectorizationStartTask(AiVectorizationStartTaskRequest)
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 |
|---|---|---|---|---|
| AiVectorizationStartTaskRequest | body | AiVectorizationStartTaskRequest | 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, 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 | - |
| 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
aiVectorizationStartTask_200_response
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json