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-comprehend:amazon-comprehend-operations-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

openapi: 3.2.0
info:
  title: Amazon Comprehend Operations API
  version: '2017-11-27'
  description: Generated from AWS's published Smithy model for Amazon Comprehend. 10 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://comprehend.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Operations
paths:
  /#DetectToxicContent:
    post:
      operationId: DetectToxicContent
      summary: Detect Toxic Content
      description: Performs toxicity analysis on the list of text strings that you provide as input. The API response contains a results list that matches the size of the input list. For more information about toxicity detection, see Toxicity detection in the Amazon Comprehend Developer Guide.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DetectToxicContentResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: InvalidRequestException; TextSizeLimitExceededException; UnsupportedLanguageException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Comprehend_20171127.DetectToxicContent
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DetectToxicContentRequest'
      tags:
      - Operations
components:
  schemas:
    InternalServerException:
      type: object
      properties:
        Message:
          type: string
    ToxicContent:
      type: object
      properties:
        Name:
          type: string
          enum:
          - GRAPHIC
          - HARASSMENT_OR_ABUSE
          - HATE_SPEECH
          - INSULT
          - PROFANITY
          - SEXUAL
          - VIOLENCE_OR_THREAT
          description: The name of the toxic content type.
        Score:
          type: number
          description: Model confidence in the detected content type. Value range is zero to one, where one is highest confidence.
    ToxicLabels:
      type: object
      properties:
        Labels:
          type: array
          items:
            $ref: '#/components/schemas/ToxicContent'
          description: Array of toxic content types identified in the string.
        Toxicity:
          type: number
          description: Overall toxicity score for the string. Value range is zero to one, where one is the highest confidence.
    TextSegment:
      type: object
      properties:
        Text:
          type: string
          description: The text content.
      required:
      - Text
    DetectToxicContentResponse:
      type: object
      properties:
        ResultList:
          type: array
          items:
            $ref: '#/components/schemas/ToxicLabels'
          description: Results of the content moderation analysis. Each entry in the results list contains a list of toxic content types identified in the text, along with a confidence score for each content type. The results list also includes a toxicity score for each entry in the results list.
    DetectToxicContentRequest:
      type: object
      properties:
        TextSegments:
          type: array
          items:
            $ref: '#/components/schemas/TextSegment'
          description: A list of up to 10 text strings. Each string has a maximum size of 1 KB, and the maximum size of the list is 10 KB.
        LanguageCode:
          type: string
          enum:
          - en
          - es
          - fr
          - de
          - it
          - pt
          - ar
          - hi
          - ja
          - ko
          - zh
          - zh-TW
          description: The language of the input text. Currently, English is the only supported language.
      required:
      - TextSegments
      - LanguageCode
    InvalidRequestDetail:
      type: object
      properties:
        Reason:
          type: string
          enum:
          - DOCUMENT_SIZE_EXCEEDED
          - UNSUPPORTED_DOC_TYPE
          - PAGE_LIMIT_EXCEEDED
          - TEXTRACT_ACCESS_DENIED
          description: 'Reason codes include the following values: DOCUMENT_SIZE_EXCEEDED - Document size is too large. Check the size of your file and resubmit the request. UNSUPPORTED_DOC_TYPE - Document type is not supported. Check the file type and resubmit the request. PAGE_LIMIT_EXCEEDED - Too many pages in the document. Check the number of pages in your file and resubmit the request. TEXTRACT_ACCESS_DENIED - Access denied to Amazon Textract. Verify that your account has permission to use Amazon Textract API operations and resubmit the request. NOT_TEXTRACT_JSON - Document is not Amazon Textract JSON format. Ve'
    InvalidRequestException:
      type: object
      properties:
        Message:
          type: string
        Reason:
          type: string
          enum:
          - INVALID_DOCUMENT
        Detail:
          $ref: '#/components/schemas/InvalidRequestDetail'
  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: comprehend
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/comprehend/service/2017-11-27/comprehend-2017-11-27.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)