Getting Started

This guide will help you get started with DocuTray quickly.

Creating an Account

To start using DocuTray, you need to create an account by following these steps:

Visit the registration page at https://app.docutray.com/register

DocuTray Registration Page

Complete the required fields:
- Full Name: Enter your first and last name
- Email: Use a valid email address
- Password: Create a secure password (minimum 8 characters)
- Confirm Password: Repeat the password for verification

Completed Registration Form

Click the "Register" button
You will receive a confirmation email at the provided address. Open this email and click the verification link.

Verification Email

Done! Once your account is verified, you can log in and start using DocuTray.

If you already have an account, you can go directly to the login page.

Creating an API Key

After creating your account, you can generate an API Key to integrate DocuTray with your applications by following these steps:

Log in to your DocuTray account at https://app.docutray.com/login
Select the organization you want to work with
Navigate to "Account" > "API Keys" in the navigation menu

API Keys Menu

Click the "New API Key" button
Enter a descriptive name for your API Key and click "Create"

Create New API Key

Copy the generated API Key and store it in a safe place. Important: This will be the only time you can see the complete key.

Copy API Key

You can now use this API Key to authenticate your requests to the DocuTray API.

Your First Conversion

Once you have your API Key, you can process your first document with a simple API call.

Supported File Formats

DocuTray supports the following file formats:

Images: JPEG, PNG, GIF, BMP, WebP
Documents: PDF (up to 100MB)

Install the SDK

pip install docutray

npm install docutray

No installation required — cURL is available on most systems.

Making the API Call

from pathlib import Path
from docutray import Client

client = Client(api_key="YOUR_API_KEY")

result = client.convert.run(
    file=Path("invoice.pdf"),
    document_type_code="invoice"
)

print(result.data)

import DocuTray from 'docutray';
import { readFileSync } from 'fs';

const client = new DocuTray({ apiKey: 'YOUR_API_KEY' });

const result = await client.convert.run({
  file: readFileSync('invoice.pdf'),
  documentTypeCode: 'invoice',
});

console.log(result.data);

curl -X POST https://app.docutray.com/api/convert \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "image=@invoice.pdf" \
  -F "document_type_code=invoice"

Response

The API returns extracted data in JSON format according to your document type schema:

# result.data contains the extracted fields
{
    "numero_factura": "F-2024-001",
    "fecha_emision": "2024-01-15",
    "rfc_emisor": "XAXX010101000",
    "razon_social_emisor": "Empresa Ejemplo S.A. de C.V.",
    "subtotal": 1000,
    "iva": 160,
    "total": 1160
}

// result.data contains the extracted fields
{
  numero_factura: 'F-2024-001',
  fecha_emision: '2024-01-15',
  rfc_emisor: 'XAXX010101000',
  razon_social_emisor: 'Empresa Ejemplo S.A. de C.V.',
  subtotal: 1000,
  iva: 160,
  total: 1160
}

{
  "data": {
    "numero_factura": "F-2024-001",
    "fecha_emision": "2024-01-15",
    "rfc_emisor": "XAXX010101000",
    "razon_social_emisor": "Empresa Ejemplo S.A. de C.V.",
    "subtotal": 1000,
    "iva": 160,
    "total": 1160
  }
}

Tip: For large files or batch processing, use async conversion which processes documents in the background:

status = client.convert.run_async(
    file=Path("large_document.pdf"),
    document_type_code="invoice"
)
# Poll for completion
final = status.wait()
print(final.data)

const status = await client.convert.runAsync({
  file: readFileSync('large_document.pdf'),
  documentTypeCode: 'invoice',
});
// Poll for completion
const final = await status.wait();
console.log(final.data);

# Start async conversion
curl -X POST https://app.docutray.com/api/convert-async \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "image=@large_document.pdf" \
  -F "document_type_code=invoice"

# Check status with the returned conversion_id
curl https://app.docutray.com/api/convert-async/CONVERSION_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

Next Steps

Now that you've completed your first conversion, explore these resources:

Operations — Unified guides for conversion, identification, and more
Document Types — Browse available document types and their schemas
Webhooks — Set up webhooks to receive conversion results automatically
Guides — Step-by-step tutorials for common use cases
Node.js SDK — Node.js SDK reference and guides
Python SDK — Python SDK reference and guides
API Reference — Complete API documentation with all endpoints

Getting Started

On this page