Amazon Web Services, Inc.

Amazon Textract

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract.

AI & machine learning#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Textract detects and analyzes text in documents and converts it
into machine-readable text. This is the API reference documentation for
Amazon Textract.

Endpoints 25

  • POSTAnalyze document/#X-Amz-Target=Textract.AnalyzeDocumentAnalyzes an input document for relationships between detected items. The types of information returned are as follows: Form data (key-value pairs). The…
  • POSTAnalyze expense/#X-Amz-Target=Textract.AnalyzeExpenseAnalyzeExpense synchronously analyzes an input document for financially related relationships between text. Information is returned as ExpenseDocuments and…
  • POSTAnalyze iD/#X-Amz-Target=Textract.AnalyzeIDAnalyzes identity documents for relevant information. This information is extracted and returned as IdentityDocumentFields , which records both the normalized…
  • POSTCreate adapter/#X-Amz-Target=Textract.CreateAdapterCreates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only…
  • POSTCreate adapter version/#X-Amz-Target=Textract.CreateAdapterVersionCreates a new version of an adapter. Operates on a provided AdapterId and a specified dataset provided via the DatasetConfig argument. Requires that you…
  • POSTDelete adapter/#X-Amz-Target=Textract.DeleteAdapterDeletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.
  • POSTDelete adapter version/#X-Amz-Target=Textract.DeleteAdapterVersionDeletes an Amazon Textract adapter version. Requires that you specify both an AdapterId and a AdapterVersion. Deletes the adapter version specified by the…
  • POSTDetect document text/#X-Amz-Target=Textract.DetectDocumentTextDetects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be in one of…
  • POSTGet adapter/#X-Amz-Target=Textract.GetAdapterGets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status,…
  • POSTGet adapter version/#X-Amz-Target=Textract.GetAdapterVersionGets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig,…
  • POSTGet document analysis/#X-Amz-Target=Textract.GetDocumentAnalysisGets the results for an Amazon Textract asynchronous operation that analyzes text in a document. You start asynchronous text analysis by calling…
  • POSTGet document text detection/#X-Amz-Target=Textract.GetDocumentTextDetectionGets the results for an Amazon Textract asynchronous operation that detects text in a document. Amazon Textract can detect lines of text and the words that…
  • POSTGet expense analysis/#X-Amz-Target=Textract.GetExpenseAnalysisGets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items…
  • POSTGet lending analysis/#X-Amz-Target=Textract.GetLendingAnalysisGets the results for an Amazon Textract asynchronous operation that analyzes text in a lending document. You start asynchronous text analysis by calling…
  • POSTGet lending analysis summary/#X-Amz-Target=Textract.GetLendingAnalysisSummaryGets summarized results for the StartLendingAnalysis operation, which analyzes text in a lending document. The returned summary consists of information about…
  • POSTList adapter versions/#X-Amz-Target=Textract.ListAdapterVersionsList all version of an adapter that meet the specified filtration criteria.
  • POSTList adapters/#X-Amz-Target=Textract.ListAdaptersLists all adapters that match the specified filtration criteria.
  • POSTList tags for resource/#X-Amz-Target=Textract.ListTagsForResourceLists all tags for an Amazon Textract resource.
  • POSTStart document analysis/#X-Amz-Target=Textract.StartDocumentAnalysisStarts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.…
  • POSTStart document text detection/#X-Amz-Target=Textract.StartDocumentTextDetectionStarts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.…
  • POSTStart expense analysis/#X-Amz-Target=Textract.StartExpenseAnalysisStarts the asynchronous analysis of invoices or receipts for data like contact information, items purchased, and vendor names. StartExpenseAnalysis can…
  • POSTStart lending analysis/#X-Amz-Target=Textract.StartLendingAnalysisStarts the classification and analysis of an input document. StartLendingAnalysis initiates the classification and analysis of a packet of lending documents.…
  • POSTTag resource/#X-Amz-Target=Textract.TagResourceAdds one or more tags to the specified resource.
  • POSTUntag resource/#X-Amz-Target=Textract.UntagResourceRemoves any tags with the specified keys from the specified resource.
  • POSTUpdate adapter/#X-Amz-Target=Textract.UpdateAdapterUpdate the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.

API details

Base URL
https://textract.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
25 operations on 25 pathsPOST 25
Description format
AWS Smithy model, API version 2018-06-27

How to test the Amazon Textract in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Textract collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Analyze document” (POST /#X-Amz-Target=Textract.AnalyzeDocument), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Textract?

Amazon Textract detects and analyzes text in documents and converts it into machine-readable text. This is the API reference documentation for Amazon Textract. It is listed under AI & machine learning and has 25 endpoints.

Who publishes the Amazon Textract?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Textract?

Requests go to https://textract.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Textract?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Textract have?

25 operations on 25 paths (25 POST).

Is forking the Amazon Textract free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.