Processing

Document processing endpoints

Process document

post

https://api.visobird.comhttp://localhost:3000

/api/v1/process

Process documents (receipts, invoices, business cards) for data extraction.

Supports two input methods:

1. File upload via multipart/form-data

2. Image URL via JSON payload

Authorizations

BearerAuth

Body

multipart/form-dataapplication/json

filestring · binaryRequired

Image file (JPEG, PNG, PDF, etc.)

typestring · enumRequired

Type of document to process

Possible values:

Responses

200

Document processed successfully

application/json

400

Bad request

application/json

401

Authentication required or invalid API key

application/json

413

File too large

application/json

415

Unsupported media type

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

post

/api/v1/process

HTTPcURLJavaScriptPython

POST /api/v1/process HTTP/1.1
Host: api.visobird.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 41

{
  "file": "[binary data]",
  "type": "receipt"
}

multipart/form-dataapplication/json

{
  "success": true,
  "documentId": "doc_1755519937452_d83cqltsq",
  "type": "receipt",
  "extractedData": {
    "merchant": "Red Object (Tseung Kwan O)",
    "address": "Shop 353B, 3/F, The LOHAS, 1 Lohas Park Road, Tseung Kwan O",
    "date": "2024-12-01",
    "time": "08:00:00",
    "total": 208,
    "tax": 0,
    "subtotal": 208,
    "currency": "$",
    "confidence": 0.85,
    "processingTime": 1250,
    "items": [
      {
        "name": "輕煎美國牛肩片",
        "quantity": 1,
        "unitPrice": 98,
        "totalPrice": 98,
        "category": "Food"
      }
    ],
    "receiptId": "41A",
    "paymentMethod": "支付寶",
    "handwritingDetected": false,
    "tampered": false
  }
}