Getting Started with the TextLift API

Introduction to the TextLift API

The TextLift API lets you programmatically convert images and documents using our AI-powered OCR engine. It's designed for developers who need to automate document processing at scale.

Getting Your API Key

1. Sign up for a TextLift account
2. Navigate to Dashboard → API Keys
3. Generate a new API key
4. Use the key in your API requests

Making Your First Request

Authentication

All API requests require authentication via your API key in the Authorization header.

Endpoints

• POST /api/v1/ocr — Extract text from images
• POST /api/v1/convert — Convert document formats
• GET /api/v1/usage — Check your credit balance

Best Practices

• Rate limiting — Respect the rate limits for your plan
• Error handling — Always handle API errors gracefully
• Caching — Cache results when possible to save credits
• Security — Never expose your API key in client-side code

Code Example

Here's a simple example using JavaScript:

const response = await fetch('https://api.textlift.info/v1/ocr', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ image_url: 'https://example.com/image.jpg' })
});

Conclusion

The TextLift API makes it easy to add OCR and document conversion to any application. Start building today with our free tier.