<commit_before>---
title: Endpoints
layout: reference
---

# Endpoints

* [Definitions of Resources](#definitions-of-resources)
  * [Supported Image Formats](#supported-image-formats)
* [General](#general)
  * [GET Service Index](#endpoint-service-index)
  * [GET Receipt Status by Receipt ID](#endpoint-get-receipt-status)
* [E-Receipts](#e-receipts)
  * [GET Schemas](#endpoint-schemas)
  * [POST Receipts](#endpoint-post-a-receipt)
  * [GET Receipts by User ID](#endpoint-get-receipts-by-userid)
  * [GET Receipts by Receipt ID](#endpoint-get-a-receipt-by-id)
  * [GET Receipt Image by Receipt ID](#endpoint-get-receipt-image)
* [Image-Only Receipts](#image-only-receipts)
  * [POST Image-Only Receipts](#endpoint-post-an-image-only-receipt)
  * [GET Image-Only Receipts by User ID](#endpoint-get-image-only-receipts-by-userid)
  * [GET Image-Only Receipt by Receipt ID](#endpoint-get-an-image-only-receipt-by-id)
  * [GET Receipt Image by Receipt ID](#endpoint-get-receipt-image-image-only)

### Definitions of Resources

* *__E-Receipt__* - A schema-enforced resource with data and, optionally, an image. If an image is not provided, one will be generated from the data resource.
* *__Image-Only Receipt__* - A standalone image without data.

#### <a name="supported-image-formats"></a>Supported Image Formats

* Image size must not exceed 5MB.
* Images with any dimension exceeding 2,200 pixels will be reduced, with the longest dimension reduced to 2,200 pixels and the remaining dimensions scaled down using a fixed aspect ratio.
* Image must be one of the supported file types: image/png, image/jpg, image/jpeg, image/tiff, image/tif, image/gif, and application/pdf. Images provided in image/tiff and image/tif will be converted to a PDF document with the image embedded within.

### General<commit_msg>Updates max image file size for upload for Receipts<commit_after>---
title: Endpoints
layout: reference
---

# Endpoints

* [Definitions of Resources](#definitions-of-resources)
  * [Supported Image Formats](#supported-image-formats)
* [General](#general)
  * [GET Service Index](#endpoint-service-index)
  * [GET Receipt Status by Receipt ID](#endpoint-get-receipt-status)
* [E-Receipts](#e-receipts)
  * [GET Schemas](#endpoint-schemas)
  * [POST Receipts](#endpoint-post-a-receipt)
  * [GET Receipts by User ID](#endpoint-get-receipts-by-userid)
  * [GET Receipts by Receipt ID](#endpoint-get-a-receipt-by-id)
  * [GET Receipt Image by Receipt ID](#endpoint-get-receipt-image)
* [Image-Only Receipts](#image-only-receipts)
  * [POST Image-Only Receipts](#endpoint-post-an-image-only-receipt)
  * [GET Image-Only Receipts by User ID](#endpoint-get-image-only-receipts-by-userid)
  * [GET Image-Only Receipt by Receipt ID](#endpoint-get-an-image-only-receipt-by-id)
  * [GET Receipt Image by Receipt ID](#endpoint-get-receipt-image-image-only)

### Definitions of Resources

* *__E-Receipt__* - A schema-enforced resource with data and, optionally, an image. If an image is not provided, one will be generated from the data resource.
* *__Image-Only Receipt__* - A standalone image without data.

#### <a name="supported-image-formats"></a>Supported Image Formats

* Image size must not exceed 25MB.
* Images with any dimension exceeding 2,200 pixels will be reduced, with the longest dimension reduced to 2,200 pixels and the remaining dimensions scaled down using a fixed aspect ratio.
* Image must be one of the supported file types: image/png, image/jpg, image/jpeg, image/tiff, image/tif, image/gif, and application/pdf. Images provided in image/tiff and image/tif will be converted to a PDF document with the image embedded within.

### General
{'fraction_non_alphanumeric': 0.12394212394212394, 'fraction_numerical': 0.005187005187005187, 'mean_word_length': 4.6630602782071096, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6637826', 'n_tokens_mistral': 1248, 'n_tokens_neox': 1125, 'n_words': 357}