Amazon Textract

Amazon Textract Textract Adapter API

The Textract Adapter API from Amazon Textract — 5 operation(s) for textract adapter.

GitHub OpenAPI

Operations 5

POST /#CreateAdapter Create Adapter #
POST /#DeleteAdapter Delete Adapter #
POST /#GetAdapter Get Adapter #
POST /#ListAdapters List Adapters #
POST /#UpdateAdapter Update Adapter #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-textract/openapi/amazon-textract-adapter-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/amazon-textract:amazon-textract-adapter-api"
All apis 
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.

Get an API 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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-textract-adapter-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Amazon Textract Adapter API
  version: '2018-06-27'
  description: Generated from AWS's published Smithy model for Amazon Textract. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://textract.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Adapter
paths:
  /#CreateAdapter:
    post:
      operationId: CreateAdapter
      summary: Create Adapter
      description: Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is QUERIES. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateAdapterResponse'
        '400':
          description: AccessDeniedException; ConflictException; IdempotentParameterMismatchException; InvalidParameterException; LimitExceededException; ProvisionedThroughputExceededException; ServiceQuotaExceededException; ValidationException
          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.CreateAdapter
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateAdapterRequest'
      tags:
      - Adapter
  /#DeleteAdapter:
    post:
      operationId: DeleteAdapter
      summary: Delete Adapter
      description: Deletes an Amazon Textract adapter. Takes an AdapterId and deletes the adapter specified by the ID.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteAdapterResponse'
        '400':
          description: AccessDeniedException; ConflictException; InvalidParameterException; ProvisionedThroughputExceededException; ResourceNotFoundException; ValidationException
          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.DeleteAdapter
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteAdapterRequest'
      tags:
      - Adapter
  /#GetAdapter:
    post:
      operationId: GetAdapter
      summary: Get Adapter
      description: Gets configuration information for an adapter specified by an AdapterId, returning information on AdapterName, Description, CreationTime, AutoUpdate status, and FeatureTypes.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetAdapterResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; ProvisionedThroughputExceededException; ResourceNotFoundException; ValidationException
          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.GetAdapter
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetAdapterRequest'
      tags:
      - Adapter
  /#ListAdapters:
    post:
      operationId: ListAdapters
      summary: List Adapters
      description: Lists all adapters that match the specified filtration criteria.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListAdaptersResponse'
        '400':
          description: AccessDeniedException; InvalidParameterException; ProvisionedThroughputExceededException; ValidationException
          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.ListAdapters
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListAdaptersRequest'
      tags:
      - Adapter
  /#UpdateAdapter:
    post:
      operationId: UpdateAdapter
      summary: Update Adapter
      description: Update the configuration for an adapter. FeatureTypes configurations cannot be updated. At least one new parameter must be specified as an argument.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateAdapterResponse'
        '400':
          description: AccessDeniedException; ConflictException; InvalidParameterException; ProvisionedThroughputExceededException; ResourceNotFoundException; ValidationException
          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.UpdateAdapter
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateAdapterRequest'
      tags:
      - Adapter
components:
  schemas:
    ListAdaptersRequest:
      type: object
      properties:
        AfterCreationTime:
          type: string
          format: date-time
          description: Specifies the lower bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created after the specified creation time.
        BeforeCreationTime:
          type: string
          format: date-time
          description: Specifies the upper bound for the ListAdapters operation. Ensures ListAdapters returns only adapters created before the specified creation time.
        MaxResults:
          type: integer
          description: The maximum number of results to return when listing adapters.
        NextToken:
          type: string
          description: Identifies the next page of results to return when listing adapters.
    DeleteAdapterResponse:
      type: object
      properties: {}
    GetAdapterRequest:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing a unique ID for the adapter.
      required:
      - AdapterId
    CreateAdapterRequest:
      type: object
      properties:
        AdapterName:
          type: string
          description: The name to be assigned to the adapter being created.
        ClientRequestToken:
          type: string
          description: Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.
        Description:
          type: string
          description: The description to be assigned to the adapter being created.
        FeatureTypes:
          type: array
          items:
            type: string
            enum:
            - TABLES
            - FORMS
            - QUERIES
            - SIGNATURES
            - LAYOUT
          description: 'The type of feature that the adapter is being trained on. Currrenly, supported feature types are: QUERIES'
        AutoUpdate:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Controls whether or not the adapter should automatically update.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A list of tags to be added to the adapter.
      required:
      - AdapterName
      - FeatureTypes
    GetAdapterResponse:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string identifying the adapter that information has been retrieved for.
        AdapterName:
          type: string
          description: The name of the requested adapter.
        CreationTime:
          type: string
          format: date-time
          description: The date and time the requested adapter was created at.
        Description:
          type: string
          description: The description for the requested adapter.
        FeatureTypes:
          type: array
          items:
            type: string
            enum:
            - TABLES
            - FORMS
            - QUERIES
            - SIGNATURES
            - LAYOUT
          description: List of the targeted feature types for the requested adapter.
        AutoUpdate:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: Binary value indicating if the adapter is being automatically updated or not.
        Tags:
          type: object
          additionalProperties:
            type: string
          description: A set of tags (key-value pairs) associated with the adapter that has been retrieved.
    UpdateAdapterResponse:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing a unique ID for the adapter that has been updated.
        AdapterName:
          type: string
          description: A string containing the name of the adapter that has been updated.
        CreationTime:
          type: string
          format: date-time
          description: An object specifying the creation time of the the adapter that has been updated.
        Description:
          type: string
          description: A string containing the description of the adapter that has been updated.
        FeatureTypes:
          type: array
          items:
            type: string
            enum:
            - TABLES
            - FORMS
            - QUERIES
            - SIGNATURES
            - LAYOUT
          description: List of the targeted feature types for the updated adapter.
        AutoUpdate:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The auto-update status of the adapter that has been updated.
    InternalServerError:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        Code:
          type: string
    CreateAdapterResponse:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing the unique ID for the adapter that has been created.
    ListAdaptersResponse:
      type: object
      properties:
        Adapters:
          type: array
          items:
            $ref: '#/components/schemas/AdapterOverview'
          description: A list of adapters that matches the filtering criteria specified when calling ListAdapters.
        NextToken:
          type: string
          description: Identifies the next page of results to return when listing adapters.
    AdapterOverview:
      type: object
      properties:
        AdapterId:
          type: string
          description: A unique identifier for the adapter resource.
        AdapterName:
          type: string
          description: A string naming the adapter resource.
        CreationTime:
          type: string
          format: date-time
          description: The date and time that the adapter was created.
        FeatureTypes:
          type: array
          items:
            type: string
            enum:
            - TABLES
            - FORMS
            - QUERIES
            - SIGNATURES
            - LAYOUT
          description: The feature types that the adapter is operating on.
    DeleteAdapterRequest:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing a unique ID for the adapter to be deleted.
      required:
      - AdapterId
    UpdateAdapterRequest:
      type: object
      properties:
        AdapterId:
          type: string
          description: A string containing a unique ID for the adapter that will be updated.
        Description:
          type: string
          description: The new description to be applied to the adapter.
        AdapterName:
          type: string
          description: The new name to be applied to the adapter.
        AutoUpdate:
          type: string
          enum:
          - ENABLED
          - DISABLED
          description: The new auto-update status to be applied to the adapter.
      required:
      - AdapterId
  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-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/textract/service/2018-06-27/textract-2018-06-27.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)