POST
/
upload
curl --request POST \
  --url https://api.taam.cloud/upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form enable_ocr=false \
  --form enable_vision=true \
  --form save_all=false \
  --form text_only=false \
  --form vision_only=false \
  --form page_based=false \
  --form images_only=false \
  --form extract_mode=default \
  --form remove_headers=true
{
  "status": true,
  "content": "<string>",
  "type": "pdf",
  "error": "<string>"
}

​
File Upload API

The File Upload API processes various document formats, extracts text and data, and provides specialized processing options for AI workflows. It can handle documents, images, and audio files with different extraction modes.

​
Base URLs

Taam Cloud offers two upload endpoints:

POST https://api.taam.cloud/v1/files

Use this endpoint for simple file uploads with basic processing options.

​
Supported File Types

Documents

PDF (.pdf), Word (.docx), PowerPoint (.pptx), Excel (.xlsx, .xls), Text (.txt)

Images

JPG, PNG, WEBP, GIF, SVG, BMP, TIFF

Audio

MP3, WAV, OGG, M4A (requires Azure Speech config)

Data

JSON, XML, CSV

​
Size Limits

Maximum file size: 50 MB per file

​
Processing Options

The OpenAPI playground above allows you to test file uploads with various processing options. Use the parameters described below.

​
Common Parameters

​
enable_ocr
string
default:"false"

Enable Optical Character Recognition for image-based documents

​
enable_vision
string
default:"true"

Enable Vision processing for images and visually-rich content

​
save_all
string
default:"false"

Save raw files along with processed output to storage

​
Advanced Parameters

​
text_only
string
default:"false"

Extract only text content from the document

​
vision_only
string
default:"false"

Process with vision models only (for images)

​
page_based
string
default:"false"

Return content organized by pages

​
images_only
string
default:"false"

Extract only images from documents

​
extract_mode
string
default:"default"

Extraction mode: ‘default’ or ‘embeddings’

​
remove_headers
string
default:"true"

Remove headers/footers from documents

​
Example Usage

​
Basic File Upload

curl -X POST \
  'https://uploud.taam.cloud/upload' \
  -F 'file=@/path/to/document.pdf'

​
With OCR Processing

curl -X POST \
  'https://uploud.taam.cloud/upload' \
  -F 'file=@/path/to/document.pdf' \
  -F 'enable_ocr=true' \
  -F 'enable_vision=false'

​
Extract for AI Embeddings

curl -X POST \
  'https://uploud.taam.cloud/upload' \
  -F 'file=@/path/to/document.pdf' \
  -F 'extract_mode=embeddings'

​
Page-Based Extraction

curl -X POST \
  'https://uploud.taam.cloud/upload' \
  -F 'file=@/path/to/document.pdf' \
  -F 'page_based=true'

​
Response Formats

​
Standard Processing

​
status
boolean

Success status of the upload and processing

​
content
string

Extracted text or data URL

​
type
string

Detected file type (pdf, docx, image, etc.)

​
error
string

Error message (if any)

​
Embeddings Mode

​
id
string

Unique identifier for the request

​
object
string

Object type (e.g., ‘chunks’)

​
created
integer

Unix timestamp when the request was created

​
data
object
​
usage
object

​
Example Response (Standard)

{
  "status": true,
  "content": "This document provides information about...",
  "type": "pdf",
  "error": ""
}

​
Example Response (Embeddings Mode)

{
  "id": "scrape-aec35e29-703d-4eaf-b1c4-5cda9fd66951",
  "object": "chunks",
  "created": 1732654897,
  "data": {
    "success": true,
    "data": {
      "metadata": {
        "title": "Annual_Report_2023",
        "description": "Annual financial report",
        "language": "en"
      },
      "chunks": [
        {
          "content": "Executive Summary\nThe fiscal year 2023 showed strong performance...",
          "total_tokens": 125,
          "from_page": 1
        },
        {
          "content": "Financial Highlights\nRevenue increased by 15% compared to the previous year...",
          "total_tokens": 142,
          "from_page": 2
        }
      ]
    }
  },
  "usage": {
    "total_chunks": 15,
    "total_extracted_text": 12500,
    "total_tokens": 2100,
    "total_pages": 25
  },
  "type": "pdf",
  "error": ""
}

​
Special Features

​
Error Handling

If an error occurs, the API returns a JSON object with the error message:

{
  "status": false,
  "content": "",
  "type": "error",
  "error": "File size exceeds the maximum limit"
}

Common errors include:

  • File size limit exceeded
  • Unsupported file type
  • OCR service unavailable
  • Processing timeout

​
Integration with AI Services

The extracted content can be used directly with Taam Cloud’s AI models:

{
  "model": "gpt-4o",
  "messages": [
    {
      "role": "user",
      "content": [
        {"type": "text", "text": "Summarize this document"},
        {"type": "text", "text": "EXTRACTED_DOCUMENT_CONTENT"}
      ]
    }
  ]
}

For large documents, use the embeddings mode and work with the chunked output for better AI processing.

Authorizations

​
Authorization
string
header
required

Enter your API key prefixed with 'Bearer '

Body

multipart/form-data

Response

200
application/json

File successfully processed

The response is of type object.