Expert Document Support

Get assistance from our historical document specialists for your research projects

Contact Support

Scripily API Documentation

Integrate historical document OCR, text extraction, and analysis capabilities directly into your applications

Get Free API Key

Overview

The Scripily API provides programmatic access to our advanced historical document OCR and text analysis capabilities. Integrate powerful text extraction, language detection, and document analysis directly into your applications.

Advanced OCR

Extract text from historical documents with 95%+ accuracy using specialized OCR models

AI Enhancement

AI-powered text correction and enhancement for difficult historical scripts

Fast Processing

Process documents in seconds with our scalable cloud infrastructure

Base URL
https://app.scripily.com/api/v1

Authentication

All API requests require authentication using a Bearer token. You can generate API keys from your dashboard.

Using Your API Key

Include your API key in the Authorization header of every request:

Authorization: Bearer sk_your_api_key_here

Security Best Practices

  • Never commit API keys to version control
  • Rotate keys every 90 days
  • Use environment variables for key storage
  • Restrict keys to specific IP ranges if possible

Endpoints

Code Examples

Select your preferred language

POST/api/v1/extract10 points/call

Extract Text from Image

Extract text from images using advanced OCR with AI enhancement for historical documents.

Example Request

curl
curl -X POST https://app.scripily.com/api/v1/extract \
  -H "Authorization: Bearer sk_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "imageUrl": "https://example.com/image.jpg",
    "language": "en",
    "enhance": true
  }'

Parameters

NameTypeRequiredDescription
imageUrlstringYesURL of the image to process
languagestringNoLanguage code (default: en)Default: en
enhancebooleanNoEnable AI enhancementDefault:
formatstringNoOutput formatDefault: json

Response

Status Codes
200: Success
400: Bad Request
401: Unauthorized
Example Response
{
  "success": true,
  "text": "Extracted historical document text...",
  "enhanced": true,
  "language": "en",
  "confidence": 0.97,
  "pointsUsed": 10,
  "remainingPoints": 990,
  "processingTime": 1.24
}
GET/api/v1/status

Check API Status

Get your API key status, remaining points, and usage statistics.

Example Request

curl
curl -X GET https://app.scripily.com/api/v1/status \
  -H "Authorization: Bearer sk_your_api_key_here"

Response

Status Codes
200: Success
401: Unauthorized
Example Response
{
  "success": true,
  "status": "active",
  "plan": "pro",
  "pointsUsed": 150,
  "pointsRemaining": 9850,
  "pointsTotal": 10000,
  "rateLimit": {
    "limit": 5000,
    "remaining": 4890,
    "reset": 1672531200
  }
}

Error Handling

All errors follow a consistent JSON response format. Always check the response status code and handle errors gracefully.

Error Response Format

{
  "success": false,
  "error": "Error description in human-readable format",
  "code": "ERROR_CODE",
  "message": "Technical error message for debugging",
  "details": {
    "field": "specific field error if applicable"
  },
  "remainingPoints": 0,
  "nextReset": "2024-01-01T00:00:00Z"
}
CodeStatusDescriptionResolution
INVALID_API_KEY401API key is invalid, expired, or revokedGenerate a new API key from your dashboard
INSUFFICIENT_POINTS402Not enough points for this operationUpgrade your plan or wait for monthly reset
RATE_LIMITED429Rate limit exceededWait for rate limit reset or upgrade plan
INVALID_REQUEST400Missing or invalid parametersCheck request parameters and try again
SERVER_ERROR500Internal server errorContact support if issue persists

Examples

Extract Text from Historical Document

Extract text from a historical document image with AI enhancement enabled.

Request

fetch('https://app.scripily.com/api/v1/extract', { method: 'POST', headers: { 'Authorization': 'Bearer YOUR_API_KEY', 'Content-Type': 'application/json' }, body: JSON.stringify({ imageUrl: 'https://archive.org/image.jpg', language: 'en', enhance: true }) })

Response

{ "success": true, "text": "19th century manuscript text...", "confidence": 0.96, "pointsUsed": 10 }

Check API Status

Monitor your API usage and remaining points programmatically.

Request

import requests url = "https://app.scripily.com/api/v1/status" headers = { "Authorization": "Bearer YOUR_API_KEY" } response = requests.get(url, headers=headers)

Response

{ "plan": "pro", "pointsUsed": 250, "pointsRemaining": 9750, "rateLimitRemaining": 4875 }

Frequently Asked Questions

How are points consumed?

Each API call consumes points based on the endpoint. Text extraction costs 10 points per image. Status checks are free. Points reset monthly based on your subscription plan.

What image formats are supported?

We support JPEG, PNG, TIFF, BMP, and WebP formats. Images should be clear with a minimum resolution of 300 DPI for best OCR results.

How accurate is the OCR?

Our OCR accuracy ranges from 95-99% for printed historical documents and 85-95% for handwritten documents, depending on document quality and script type.

How do I get an API key?

Sign up for a free account at app.scripily.com/signup. Once logged in, navigate to the API section in your dashboard to generate your first API key.

Still have questions?

Contact our support team or join our community for help.

Ready to Get Started?

Sign up for a free account and get your API key to start integrating historical document OCR into your applications.