DocuTray
DocumentationAPI ReferenceDocuTray.com
API ReferenceKnowledge bases

Update a Knowledge Base

PUT
/api/knowledge-bases/{id}

Updates the details of an existing Knowledge Base.

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Bearer token for API authentication

In: header

Path Parameters

id*string

Unique ID of the Knowledge Base

Request Body

application/json

name?string

New name for the Knowledge Base

description?string

New description for the Knowledge Base

schema?object

Updated JSON schema for documents

indexingPreferences?object

Updated indexing preferences

isActive?boolean

Active status of the Knowledge Base

Response Body

application/json

curl -X PUT "https://app.docutray.com/api/knowledge-bases/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "schema": {},
    "indexingPreferences": {},
    "isActive": true,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
Empty
Empty
Empty
Empty
Empty
Empty
Empty

List organization's Knowledge Bases GET

Retrieves the list of Knowledge Bases for the authenticated user's organization. Supports search filters and pagination.

Execute a document processing step asynchronously POST

Process documents using the specified Step configuration asynchronously. **Supported file formats:** - image/jpeg (JPEG) - image/png (PNG) - image/gif (GIF) - image/bmp (BMP) - image/webp (WebP) - application/pdf (PDF) **Size limits:** - Maximum file size: 100MB - URL download timeout: 30 seconds **Request methods:** 1. **multipart/form-data**: Direct file upload 2. **application/json with base64**: Base64-encoded image 3. **application/json with URL**: Image URL for automatic download **Async workflow:** 1. Submit document for processing (returns execution_id) 2. Poll `/api/steps-async/status/{executionId}` for completion 3. Retrieve extracted data when status is SUCCESS