Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.chamelio.ai/llms.txt

Use this file to discover all available pages before exploring further.

Event

core.document.upload_with_issues
This event fires when document processing completes but Chamelio detected one or more issues (e.g., unsupported content, partially readable pages, or metadata extraction failures). The document is stored and accessible, but action may be required.

Payload Example

{
  "event": "core.document.upload_with_issues",
  "event_id": "evt_01HXYZ9876543210",
  "organization_id": "org_abc123",
  "timestamp": "2025-06-01T14:35:22Z",
  "data": {
    "document_processing_id": 12345,
    "file_id": "file_abc123",
    "file_name": "scanned_contract.pdf",
    "file_extension": "pdf",
    "uploaded_by": "john.doe@example.com",
    "issues": [
      {
        "code": "Duplicate",
        "message": "Document is duplicate",
      }
    ]
  }
}

Payload Fields

Envelope

FieldTypeDescription
eventstringAlways core.document.upload_with_issues
event_idstringUnique delivery ID — use to deduplicate retries
organization_idstringID of the organization that owns the document
timestampstringISO 8601 UTC timestamp of the event
dataobjectEvent-specific payload (see below)

Data Object

FieldTypeDescription
document_processing_idintegerID of the async processing job
file_idstringPermanent unique identifier for the document
file_namestringOriginal file name
file_extensionstringFile extension (e.g., pdf, docx)
uploaded_bystringEmail of the user who triggered the upload
issuesarrayList of issue objects detected during processing

Issue Object

FieldTypeDescription
codestringMachine-readable issue code
messagestringHuman-readable description of the issue
pagesarrayPage numbers affected (if applicable)

Notes

Documents with issues are still stored and accessible, but the extracted content or metadata may be incomplete. Review the document in the Chamelio web application to assess the impact.