Documents

Documentation Index

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

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

​

Getting Started

​

How Document Management Works

1. Upload documents: Send files with metadata to create document records
2. Organize content: Add descriptions, categories, and custom metadata
3. AI Processing: Leverage AI capabilities for content extraction and analysis
4. Access control: Documents are scoped to your organization for security
5. Lifecycle management: Track creation, updates, and deletion events

​

Supported File Types

• PDF Documents: .pdf - Ideal for reports, contracts, and formal documents
• Images: .jpg, .jpeg, .png, .gif - Photos, screenshots, and visual content
• Office Documents: .docx, .xlsx, .pptx - Microsoft Office files
• Text Files: .txt, .md, .csv - Plain text and structured data
• Archives: .zip, .tar - Compressed file collections

​

Quick Start Examples

// Upload a document with metadata
const formData = new FormData();
formData.append('file', fileInput.files[0]);
formData.append('data', JSON.stringify({
  type: 'document',
  attributes: {
    name: 'Q4 Financial Report',
    description: 'Quarterly financial analysis and projections',
    category: 'finance',
    tags: ['quarterly', 'finance', '2024']
  }
}));

const uploadResponse = await fetch('https://api.well.com/v1/documents', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`
  },
  body: formData
});

const document = await uploadResponse.json();
console.log('Document uploaded:', document.data.id);

// Get document details
const getResponse = await fetch(`https://api.well.com/v1/documents/${document.data.id}`, {
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
});

// List all documents with pagination
const listResponse = await fetch('https://api.well.com/v1/documents?page=1&limit=10', {
  headers: {
    'Authorization': `Bearer ${apiKey}`
  }
});

import requests

# Upload a document with metadata
with open('financial_report.pdf', 'rb') as f:
    files = {'file': f}
    data = {
        'data': json.dumps({
            'type': 'document',
            'attributes': {
                'name': 'Q4 Financial Report',
                'description': 'Quarterly financial analysis and projections',
                'category': 'finance',
                'tags': ['quarterly', 'finance', '2024']
            }
        })
    }

    upload_response = requests.post('https://api.well.com/v1/documents',
        headers={'Authorization': f'Bearer {api_key}'},
        files=files, data=data
    )

document = upload_response.json()
print(f"Document uploaded: {document['data']['id']}")

# Get document details
get_response = requests.get(f"https://api.well.com/v1/documents/{document['data']['id']}",
    headers={'Authorization': f'Bearer {api_key}'}
)

# List all documents with pagination
list_response = requests.get('https://api.well.com/v1/documents?page=1&limit=10',
    headers={'Authorization': f'Bearer {api_key}'}
)

# Upload a document with metadata
curl -X POST https://api.well.com/v1/documents \
  -H "Authorization: Bearer $API_KEY" \
  -F "file=@financial_report.pdf" \
  -F 'data={"type":"document","attributes":{"name":"Q4 Financial Report","description":"Quarterly financial analysis","category":"finance","tags":["quarterly","finance","2024"]}}'

# Get document details
curl -X GET https://api.well.com/v1/documents/DOCUMENT_ID \
  -H "Authorization: Bearer $API_KEY"

# List all documents with pagination
curl -X GET "https://api.well.com/v1/documents?page=1&limit=10" \
  -H "Authorization: Bearer $API_KEY"

# Delete a document
curl -X DELETE https://api.well.com/v1/documents/DOCUMENT_ID \
  -H "Authorization: Bearer $API_KEY"

​

Document Management

​

Document Response Structure

​

Single Document Response

{
  "data": {
    "type": "document",
    "id": "doc_12345",
    "attributes": {
      "name": "Q4 Financial Report",
      "description": "Quarterly financial analysis and projections",
      "filename": "q4_report.pdf",
      "content_type": "application/pdf",
      "size": 2048576,
      "category": "finance",
      "tags": ["quarterly", "finance", "2024"],
      "upload_url": "https://storage.well.com/documents/doc_12345.pdf",
      "organisation_id": "org_67890",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  }
}

​

Document List Response

{
  "data": [
    {
      "type": "document",
      "id": "doc_12345",
      "attributes": {
        "name": "Q4 Financial Report",
        "filename": "q4_report.pdf",
        "size": 2048576,
        "created_at": "2024-01-15T10:30:00Z"
      }
    }
  ],
  "meta": {
    "page": 1,
    "limit": 10,
    "total": 25,
    "total_pages": 3
  }
}

​

AI Integration

// After uploading a document, process it with AI
const aiResponse = await fetch("https://api.well.com/v1/ai", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: `Bearer ${firebaseToken}`, // Note: AI uses Firebase auth
  },
  body: JSON.stringify({
    data: {
      type: "ai-request",
      attributes: {
        html: documentContent,
        mode: "EXTRACT_DOCUMENT_DATA",
        flow: "DOCUMENT_PROCESSING",
        flow_id: document.data.id,
      },
    },
  }),
});

​

Storage & Security

• Secure Storage: All documents are stored with encryption at rest
• Access Control: Documents are scoped to your organization
• Size Limits: Maximum file size is 50MB per document
• Retention: Documents are retained according to your organization’s policy
• HTTPS Only: All document URLs use secure HTTPS protocol

​

Webhook Events

• document.uploaded - When a new document is successfully uploaded
• document.processed - When AI processing completes
• document.updated - When document metadata is modified
• document.deleted - When a document is permanently removed

​

Best Practices

1. Use descriptive names to make documents easily searchable
2. Add comprehensive metadata including categories and tags
3. Implement pagination when listing large document collections
4. Handle file size limits by checking before upload
5. Set up webhooks to track document lifecycle events
6. Use appropriate file formats for your use case
7. Store document IDs for future reference and updates