Uploading Documents

Document Upload Methods

File Upload

Upload documents directly to your knowledge base:

cURL

curl --request POST \
  --url https://api.threetone.in/v1/voiceai/knowledge-base/documents \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=@document.pdf' \
  --form 'title=Product Documentation' \
  --form 'category=support'

URL Content

Add web content by URL:

cURL

curl --request POST \
  --url https://api.threetone.in/v1/voiceai/knowledge-base/documents/url \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com/help-article",
    "title": "Help Article",
    "category": "support"
  }'

Text Content

Add structured text content:

cURL

curl --request POST \
  --url https://api.threetone.in/v1/voiceai/knowledge-base/documents/text \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "content": "This is important information about our product features...",
    "title": "Product Features",
    "category": "product_info"
  }'

Supported File Formats

Document Types

PDF: Portable Document Format files
DOC/DOCX: Microsoft Word documents
TXT: Plain text files
RTF: Rich Text Format files
MD: Markdown files

Content Processing

All uploaded content is automatically:

Extracted and parsed for text content
Indexed for semantic search
Chunked for optimal retrieval
Validated for quality and completeness

Document Management

Listing Documents

Retrieve all documents in your knowledge base:

cURL

curl --request GET \
  --url https://api.threetone.in/v1/voiceai/knowledge-base/documents \
  --header 'x-api-key: YOUR_API_KEY'

Document Details

Get detailed information about a specific document:

cURL

curl --request GET \
  --url https://api.threetone.in/v1/voiceai/knowledge-base/documents/{document_id} \
  --header 'x-api-key: YOUR_API_KEY'

Updating Documents

Update document metadata or content:

cURL

curl --request PUT \
  --url https://api.threetone.in/v1/voiceai/knowledge-base/documents/{document_id} \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Updated Title",
    "category": "new_category"
  }'

Organization and Categorization

Metadata

Add metadata to improve document searchability:

{
  "title": "Customer Onboarding Guide",
  "category": "support",
  "tags": ["onboarding", "new_customers", "setup"],
  "priority": "high",
  "last_updated": "2024-01-15"
}

Content Quality Guidelines

Best Practices

Use clear, descriptive titles
Organize content with proper headings
Include relevant keywords naturally
Keep information current and accurate
Use consistent formatting and style

Content Structure

Start with clear introductions
Use bullet points and lists for clarity
Include examples and use cases
Provide step-by-step instructions where applicable
End with relevant next steps or related information

Processing and Indexing

Automatic Processing

When you upload documents, ThreeTone automatically:

Extracts text content from files
Chunks content into searchable segments
Creates semantic embeddings for search
Indexes content for fast retrieval
Validates content quality and completeness

Processing Status

Monitor document processing status:

cURL

curl --request GET \
  --url https://api.threetone.in/v1/voiceai/knowledge-base/documents/{document_id}/status \
  --header 'x-api-key: YOUR_API_KEY'

Authentication

Voice Agents

Knowledge Base

Phone Integration

Document Upload Methods

File Upload

URL Content

Text Content

Supported File Formats

Document Types

Content Processing

Document Management

Listing Documents

Document Details

Updating Documents

Organization and Categorization

Categories

Metadata

Content Quality Guidelines

Best Practices

Content Structure

Processing and Indexing

Automatic Processing

Processing Status

Next Steps

​Document Upload Methods

​File Upload

​URL Content

​Text Content

​Supported File Formats

​Document Types

​Content Processing

​Document Management

​Listing Documents

​Document Details

​Updating Documents

​Organization and Categorization

​Categories

​Metadata

​Content Quality Guidelines

​Best Practices

​Content Structure

​Processing and Indexing

​Automatic Processing

​Processing Status

​Next Steps

Document Upload Methods

File Upload

URL Content

Text Content

Supported File Formats

Document Types

Content Processing

Document Management

Listing Documents

Document Details

Updating Documents

Organization and Categorization

Categories

Metadata

Content Quality Guidelines

Best Practices

Content Structure

Processing and Indexing

Automatic Processing

Processing Status

Next Steps