Documents Plugin

Upload 1–10 FILE documents (multipart field `files`).

POST

http://localhost:3000/api/plugins/docs/documents/upload

curl -X POST 'http://localhost:3000/api/plugins/docs/documents/upload' \
  --form-string 'tenant={}' \
  --form-string 'tenantId=string' \
  --form-string 'organization={}' \
  --form-string 'organizationId=string' \
  --form-string 'sentTo=string' \
  --form-string 'parentId=string' \
  --form-string 'visibility=ORGANIZATION' \
  --form-string 'categoryIds=string' \
  --form-string 'tagIds=string' \
  --form-string 'importToKnowledge=true' \
  --form-string 'classifyWithAi=true' \
  --form-string 'source=UPLOAD'

const form = new FormData();
form.append('tenant', '{}');
form.append('tenantId', 'string');
form.append('organization', '{}');
form.append('organizationId', 'string');
form.append('sentTo', 'string');
form.append('parentId', 'string');
form.append('visibility', 'ORGANIZATION');
form.append('categoryIds', 'string');
form.append('tagIds', 'string');
form.append('importToKnowledge', 'true');
form.append('classifyWithAi', 'true');
form.append('source', 'UPLOAD');
const response = await fetch('http://localhost:3000/api/plugins/docs/documents/upload', {
  method: 'POST',
  headers: {},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
        ('tenant', (None, '{}')),
        ('tenantId', (None, 'string')),
        ('organization', (None, '{}')),
        ('organizationId', (None, 'string')),
        ('sentTo', (None, 'string')),
        ('parentId', (None, 'string')),
        ('visibility', (None, 'ORGANIZATION')),
        ('categoryIds', (None, 'string')),
        ('tagIds', (None, 'string')),
        ('importToKnowledge', (None, 'true')),
        ('classifyWithAi', (None, 'true')),
        ('source', (None, 'UPLOAD')),
    ]
    response = requests.request('POST', 'http://localhost:3000/api/plugins/docs/documents/upload', headers={}, files=files)
    print(response.text)

Request Body

{
  "tenant": {},
  "tenantId": "string",
  "organization": {},
  "organizationId": "string",
  "sentTo": "string",
  "parentId": "string",
  "visibility": "ORGANIZATION",
  "categoryIds": [
    "string"
  ],
  "tagIds": [
    "string"
  ],
  "importToKnowledge": true,
  "classifyWithAi": true,
  "source": "UPLOAD"
}

Body

multipart/form-data

tenantobject

tenantIdstring

organizationobjectrequired

organizationIdstringrequired

sentTostring

parentIdstring

visibilitystringORGANIZATIONPRIVATE

categoryIdsArray<string>

tagIdsArray<string>

importToKnowledgeboolean

classifyWithAiboolean

sourcestringUPLOADEDITORCHATEMAILINTEGRATIONSYSTEMIMPORT

Response

201Created

Per-file upload results returned.

400Bad Request

Every file in the batch was rejected.

413Payload Too Large

Every file in the batch is oversize.

Stack Overflow Website Demo