Operations for asynchronous document processing.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-textract:amazon-textract-async-operations-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Amazon Textract Async Operations API
version: '2018-06-27'
description: 'Operations tagged Async Operations across 2 of this provider''s published API definitions: amazon-textract-openapi.yml, amazon-textract-async-operations-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://textract.amazonaws.com
description: Amazon Textract API endpoint
- url: https://textract.{region}.amazonaws.com
variables:
region:
default: us-east-1
tags:
- name: Async Operations
description: Operations for asynchronous document processing.
paths:
/#StartDocumentTextDetection:
post:
operationId: StartDocumentTextDetection
summary: Amazon Textract Start Document Text Detection
description: Starts the asynchronous detection of text in a document stored in an Amazon S3 bucket.
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
type: object
properties:
DocumentLocation:
type: object
description: The location of the document to be processed.
properties:
S3Object:
type: object
properties:
Bucket:
type: string
Name:
type: string
Version:
type: string
ClientRequestToken:
type: string
JobTag:
type: string
NotificationChannel:
type: object
properties:
SNSTopicArn:
type: string
RoleArn:
type: string
required:
- DocumentLocation
responses:
'200':
description: Asynchronous job started successfully.
content:
application/json:
schema:
type: object
properties:
JobId:
type: string
tags:
- Async Operations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
servers:
- url: https://textract.amazonaws.com
description: Amazon Textract API endpoint
/#GetDocumentTextDetection:
post:
operationId: GetDocumentTextDetection
summary: Amazon Textract Get Document Text Detection
description: Gets the results for an Amazon Textract asynchronous operation that detects text in a document.
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
type: object
properties:
JobId:
type: string
description: A unique identifier for the text detection job.
MaxResults:
type: integer
NextToken:
type: string
required:
- JobId
responses:
'200':
description: Text detection results.
content:
application/json:
schema:
type: object
properties:
DocumentMetadata:
type: object
properties:
Pages:
type: integer
JobStatus:
type: string
enum:
- IN_PROGRESS
- SUCCEEDED
- FAILED
- PARTIAL_SUCCESS
Blocks:
type: array
items:
type: object
NextToken:
type: string
tags:
- Async Operations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
servers:
- url: https://textract.amazonaws.com
description: Amazon Textract API endpoint
/#DetectDocumentText:
post:
operationId: DetectDocumentText
summary: Detect Document Text
description: 'Detects 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 the following image formats: JPEG, PNG, PDF, or TIFF. DetectDocumentText returns the detected text in an array of Block objects. Each document page has as an associated Block of type PAGE. Each PAGE Block object is the parent of LINE Block objects that represent the lines of detected text on a page. A LINE Block object is a parent for each word that makes up the line. Words are represented by Block objects of type WORD. DetectDocumentText is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection. For more information, see Document Text Detection.'
responses:
'200':
description: Success
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DetectDocumentTextResponse'
'400':
description: AccessDeniedException; BadDocumentException; DocumentTooLargeException; InvalidParameterException; InvalidS3ObjectException; ProvisionedThroughputExceededException; UnsupportedDocumentException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerError; ThrottlingException
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/InternalServerError'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Textract.DetectDocumentText
requestBody:
required: true
content:
application/x-amz-json-1.1:
schema:
$ref: '#/components/schemas/DetectDocumentTextRequest'
tags:
- Async Operations
security:
- sigv4: []
servers:
- url: https://textract.{region}.amazonaws.com
variables:
region:
default: us-east-1
components:
schemas:
BoundingBox:
type: object
properties:
Width:
type: number
description: The width of the bounding box as a ratio of the overall document page width.
Height:
type: number
description: The height of the bounding box as a ratio of the overall document page height.
Left:
type: number
description: The left coordinate of the bounding box as a ratio of overall document page width.
Top:
type: number
description: The top coordinate of the bounding box as a ratio of overall document page height.
Block:
type: object
properties:
BlockType:
type: string
enum:
- KEY_VALUE_SET
- PAGE
- LINE
- WORD
- TABLE
- CELL
- SELECTION_ELEMENT
- MERGED_CELL
- TITLE
- QUERY
- QUERY_RESULT
- SIGNATURE
- TABLE_TITLE
- TABLE_FOOTER
- LAYOUT_TEXT
- LAYOUT_TITLE
- LAYOUT_HEADER
- LAYOUT_FOOTER
- LAYOUT_SECTION_HEADER
- LAYOUT_PAGE_NUMBER
- LAYOUT_LIST
- LAYOUT_FIGURE
- LAYOUT_TABLE
- LAYOUT_KEY_VALUE
description: 'The type of text item that''s recognized. In operations for text detection, the following types are returned: PAGE - Contains a list of the LINE Block objects that are detected on a document page. WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren''t separated by spaces. LINE - A string of space-delimited, contiguous words that are detected on a document page. In text analysis operations, the following types are returned: PAGE - Contains a list of child Block objects that are detected on a document page. KEY_VALUE_SET - Stores the KEY and'
Confidence:
type: number
description: The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
Text:
type: string
description: The word or line of text that's recognized by Amazon Textract.
TextType:
type: string
enum:
- HANDWRITING
- PRINTED
description: The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
RowIndex:
type: integer
description: The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
ColumnIndex:
type: integer
description: The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
RowSpan:
type: integer
description: The number of rows that a table cell spans. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
ColumnSpan:
type: integer
description: The number of columns that a table cell spans. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
Geometry:
$ref: '#/components/schemas/Geometry'
Id:
type: string
description: The identifier for the recognized text. The identifier is only unique for a single operation.
Relationships:
type: array
items:
$ref: '#/components/schemas/Relationship'
description: A list of relationship objects that describe how blocks are related to each other. For example, a LINE block object contains a CHILD relationship type with the WORD blocks that make up the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks.
EntityTypes:
type: array
items:
type: string
enum:
- KEY
- VALUE
- COLUMN_HEADER
- TABLE_TITLE
- TABLE_FOOTER
- TABLE_SECTION_TITLE
- TABLE_SUMMARY
- STRUCTURED_TABLE
- SEMI_STRUCTURED_TABLE
description: 'The type of entity. The following entity types can be returned by FORMS analysis: KEY - An identifier for a field on the document. VALUE - The field text. The following entity types can be returned by TABLES analysis: COLUMN_HEADER - Identifies a cell that is a header of a column. TABLE_TITLE - Identifies a cell that is a title within the table. TABLE_SECTION_TITLE - Identifies a cell that is a title of a section within a table. A section title is a cell that typically spans an entire row above a section. TABLE_FOOTER - Identifies a cell that is a footer of a table. TABLE_SUMMARY - Identifies '
SelectionStatus:
type: string
enum:
- SELECTED
- NOT_SELECTED
description: The selection status of a selection element, such as an option button or check box.
Page:
type: integer
description: The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of Page is always 1.
Query:
$ref: '#/components/schemas/Query'
InternalServerError:
type: object
properties:
Message:
type: string
Code:
type: string
Point:
type: object
properties:
X:
type: number
description: The value of the X coordinate for a point on a Polygon.
Y:
type: number
description: The value of the Y coordinate for a point on a Polygon.
DocumentMetadata:
type: object
properties:
Pages:
type: integer
description: The number of pages that are detected in the document.
Query:
type: object
properties:
Text:
type: string
description: Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"
Alias:
type: string
description: Alias attached to the query, for ease of location.
Pages:
type: array
items:
type: string
description: 'Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter. If a page is not specified, it is set to ["1"] by default. The following characters are allowed in the parameter''s string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed. When using * to indicate all pages, it must be the only element in the list. You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document. Specified pages must be greater than 0 and less than or equal to the number of pages in the document.'
required:
- Text
AccessDeniedException:
type: object
properties:
Message:
type: string
Code:
type: string
DetectDocumentTextResponse:
type: object
properties:
DocumentMetadata:
$ref: '#/components/schemas/DocumentMetadata'
Blocks:
type: array
items:
$ref: '#/components/schemas/Block'
description: An array of Block objects that contain the text that's detected in the document.
DetectDocumentTextModelVersion:
type: string
Relationship:
type: object
properties:
Type:
type: string
enum:
- VALUE
- CHILD
- COMPLEX_FEATURES
- MERGED_CELL
- TITLE
- ANSWER
- TABLE
- TABLE_TITLE
- TABLE_FOOTER
description: The type of relationship between the blocks in the IDs array and the current block. The following list describes the relationship types that can be returned. VALUE - A list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. CHILD - A list of IDs that identify blocks found within the current block object. For example, WORD blocks have a CHILD relationship to the LINE block type. MERGED_CELL - A list of IDs that identify each of the MERGED_CELL block types in a table. ANSWER - A list that contains the ID of the QUERY_RESULT block that’s associated with th
Ids:
type: array
items:
type: string
description: An array of IDs for related blocks. You can get the type of the relationship from the Type element.
Geometry:
type: object
properties:
BoundingBox:
$ref: '#/components/schemas/BoundingBox'
Polygon:
type: array
items:
$ref: '#/components/schemas/Point'
description: Within the bounding box, a fine-grained polygon around the recognized item.
RotationAngle:
type: number
description: Provides a numerical value corresponding to the rotation of the WORD block. Possible values are 0, 90, 180, and 270.
S3Object:
type: object
properties:
Bucket:
type: string
description: 'The name of the S3 bucket. Note that the # character is not valid in the file name.'
Name:
type: string
description: The file name of the input document. Image files may be in PDF, TIFF, JPEG, or PNG format.
Version:
type: string
description: If the bucket has versioning enabled, you can specify the object version.
Document:
type: object
properties:
Bytes:
type: string
format: byte
description: A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format. If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes field.
S3Object:
$ref: '#/components/schemas/S3Object'
DetectDocumentTextRequest:
type: object
properties:
Document:
$ref: '#/components/schemas/Document'
required:
- Document
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: textract
x-refined-from:
- amazon-textract-openapi.yml
- amazon-textract-async-operations-api-openapi.yml