Documents

List documents

Retrieves a paginated list of documents belonging to the

GET /api/v2/documents Try It

List documents

cURL

curl --request GET \
  --url 'https://api.handwritingocr.com/v2/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer your-api-token'

import requests

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

querystring = {"per_page":"SOME_INTEGER_VALUE","page":"SOME_INTEGER_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?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_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?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_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?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_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?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_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

{
  "current_page": 1,
  "data": [
    {
      "document_id": "xyz789",
      "status": "processed",
      "created_at": "2024-03-15T14:30:00Z",
      "updated_at": "2024-03-15T14:35:00Z",
      "automatically_deleted_at": "2024-03-22T14:30:00Z",
      "page_count": 3,
      "original_file_name": "business_report.pdf",
      "action": "transcribe"
    },
    {
      "document_id": "abc123",
      "status": "queued",
      "created_at": "2024-03-15T14:25:00Z",
      "updated_at": "2024-03-15T14:25:00Z",
      "automatically_deleted_at": "2024-03-22T14:25:00Z",
      "page_count": 1,
      "original_file_name": "receipt.jpg",
      "action": "tables"
    }
  ],
  "first_page_url": "https://api.handwritingocr.com/v2/documents?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://api.handwritingocr.com/v2/documents?page=5",
  "next_page_url": "https://api.handwritingocr.com/v2/documents?page=2",
  "path": "https://api.handwritingocr.com/v2/documents",
  "per_page": 50,
  "prev_page_url": null,
  "to": 50,
  "total": 243
}

Retrieves a paginated list of documents belonging to the authenticated user. Documents are sorted by creation date in descending order.

Headers

Authorization string required header

Bearer your-api-token
Accept string required header

application/json

Query parameters

per_page integer query

Number of items per page. Default 50, maximum 200.
page integer query

The page number for pagination. Defaults to 1.

Response codes

HTTP status

200

Returns a paginated list of documents.
401

Unauthorized — invalid or missing API token.
422

Validation Error — invalid parameters.

List documents

cURL

curl --request GET \
  --url 'https://api.handwritingocr.com/v2/documents?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE' \
  --header 'Authorization: Bearer your-api-token'

import requests

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

querystring = {"per_page":"SOME_INTEGER_VALUE","page":"SOME_INTEGER_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?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_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?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_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?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_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?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_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

{
  "current_page": 1,
  "data": [
    {
      "document_id": "xyz789",
      "status": "processed",
      "created_at": "2024-03-15T14:30:00Z",
      "updated_at": "2024-03-15T14:35:00Z",
      "automatically_deleted_at": "2024-03-22T14:30:00Z",
      "page_count": 3,
      "original_file_name": "business_report.pdf",
      "action": "transcribe"
    },
    {
      "document_id": "abc123",
      "status": "queued",
      "created_at": "2024-03-15T14:25:00Z",
      "updated_at": "2024-03-15T14:25:00Z",
      "automatically_deleted_at": "2024-03-22T14:25:00Z",
      "page_count": 1,
      "original_file_name": "receipt.jpg",
      "action": "tables"
    }
  ],
  "first_page_url": "https://api.handwritingocr.com/v2/documents?page=1",
  "from": 1,
  "last_page": 5,
  "last_page_url": "https://api.handwritingocr.com/v2/documents?page=5",
  "next_page_url": "https://api.handwritingocr.com/v2/documents?page=2",
  "path": "https://api.handwritingocr.com/v2/documents",
  "per_page": 50,
  "prev_page_url": null,
  "to": 50,
  "total": 243
}