Documents

Download result

Retrieve the status of a document, or download the processed

GET /api/v2/documents/{id}[.{format}] Try It

Download result

cURL

curl --request GET \
  --url 'https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer your-api-token'

import requests

url = "https://api.handwritingocr.com/v2/documents/abcde12345"

querystring = {"format":"SOME_STRING_VALUE"}

headers = {"Authorization": "Bearer your-api-token"}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer your-api-token'}};

fetch('https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer your-api-token'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer your-api-token"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer your-api-token")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

200 application/json

{
  "id": "abc123",
  "status": "processed",
  "action": "transcribe",
  "created_at": "2024-03-15T14:30:00Z",
  "updated_at": "2024-03-15T14:35:00Z"
}

Retrieve the status of a document, or download the processed results. The format extension is optional — if not provided, returns a JSON status response. If the format extension is provided, downloads the processed document in that format.

Image thumbnail URLs are provided for each page. These images must be authenticated with your API token to download.

Webhooks

We strongly encourage using a webhook instead of polling this endpoint repeatedly. Configure a webhook in the user dashboard.

Headers

Authorization string required header

Bearer your-api-token
Accept string required header

application/json

Path parameters

id string required path

The document's unique identifier.

Query parameters

format string query

Output format passed as a URL extension on the path. Varies by action: txt, docx, xlsx, csv, json.

Response codes

HTTP status

200

Returns the processed result.
202

Accepted — document is still being processed.
400

Bad Request — invalid format for action type.
401

Unauthorized — invalid or missing API token.
403

Forbidden — no permission to access document.
404

Not found — document not found.
429

Too many requests — rate limited.
500

Server Error — error preparing file for download.

Download result

cURL

curl --request GET \
  --url 'https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer your-api-token'

import requests

url = "https://api.handwritingocr.com/v2/documents/abcde12345"

querystring = {"format":"SOME_STRING_VALUE"}

headers = {"Authorization": "Bearer your-api-token"}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer your-api-token'}};

fetch('https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer your-api-token'

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer your-api-token"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.handwritingocr.com/v2/documents/abcde12345?format=SOME_STRING_VALUE"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer your-api-token")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

200 application/json

{
  "id": "abc123",
  "status": "processed",
  "action": "transcribe",
  "created_at": "2024-03-15T14:30:00Z",
  "updated_at": "2024-03-15T14:35:00Z"
}