API Reference
Backoffice APIs
Burchelli

Burchelli API Reference

Overview

The Burchelli API provides endpoints for text processing in the TKM AI Agency Platform. It handles text analysis, processing, and metadata extraction.

Endpoints

Process Text

POST /process_text

Processes and analyzes text content.

Request Body

{
    "text": "string",
    "user_id": "string",
    "conversation_id": "string",
    "session_id": "string",          // Optional
    "context_id": "string",          // Optional
    "source_file": "string",         // Optional
    "timestamp": "2024-01-20T12:00:00Z",  // Optional
    "organization_id": "string"      // Defaults to "tkm_123456"
}

Response

{
    "success": true,
    "message": "string",
    "file_path": "string",           // Optional
    "embedding_id": "string",        // Optional
    "error": null,                   // Optional
    "metadata": {                    // Optional
        "additional": "data"
    },
    "organization_id": "string"      // Optional
}

Error Response

{
    "success": false,
    "error": "Error message"
}

Integration Notes

Text Processing Features

  • Content analysis
  • Metadata extraction
  • File path tracking
  • Embedding generation (optional)

Organization Management

  • Organization-specific processing
  • Default organization support
  • Context preservation

Session Handling

  • Session-based processing
  • Conversation context
  • Source tracking

Error Handling

  • Detailed error reporting
  • Processing validation
  • Input sanitization