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-transcribe:amazon-transcribe-call-analytics-category-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.1.0
info:
  title: Amazon Transcribe Service Call Analytics Category API
  version: '2017-10-26'
  description: Generated from AWS's published Smithy model for Amazon Transcribe Service. 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://transcribe.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateCallAnalyticsCategory:
    post:
      operationId: CreateCallAnalyticsCategory
      summary: Create Call Analytics Category
      description: 'Creates a new Call Analytics category. All categories are automatically applied to your Call Analytics
        transcriptions. Note that in order to apply categories to your transcriptions, you must create them before submitting
        your transcription request, as categories cannot be applied retroactively. When creating a new category, you can use
        the InputType parameter to label the category as a POST_CALL or a REAL_TIME category. POST_CALL categories can only
        be applied to post-call transcriptions and REAL_TIME categories can only be applied to real-time transcriptions. If
        you do not include InputType, your category is created as a POST_CALL category by default. Call Analytics categories
        are composed of rules. For each category, you must create between 1 and 20 rules. Rules can include these parameters:
        , , , and . To update an existing category, see . To learn more about Call Analytics categories, see Creating categories
        for post-call transcriptions and Creating categories for real-time transcriptions.'
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateCallAnalyticsCategoryResponse'
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.CreateCallAnalyticsCategory
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateCallAnalyticsCategoryRequest'
      tags:
      - Call Analytics Category
  /#DeleteCallAnalyticsCategory:
    post:
      operationId: DeleteCallAnalyticsCategory
      summary: Delete Call Analytics Category
      description: Deletes a Call Analytics category. To use this operation, specify the name of the category you want to
        delete using CategoryName. Category names are case sensitive.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DeleteCallAnalyticsCategoryResponse'
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.DeleteCallAnalyticsCategory
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DeleteCallAnalyticsCategoryRequest'
      tags:
      - Call Analytics Category
  /#GetCallAnalyticsCategory:
    post:
      operationId: GetCallAnalyticsCategory
      summary: Get Call Analytics Category
      description: Provides information about the specified Call Analytics category. To get a list of your Call Analytics
        categories, use the operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/GetCallAnalyticsCategoryResponse'
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.GetCallAnalyticsCategory
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/GetCallAnalyticsCategoryRequest'
      tags:
      - Call Analytics Category
  /#ListCallAnalyticsCategories:
    post:
      operationId: ListCallAnalyticsCategories
      summary: List Call Analytics Categories
      description: Provides a list of Call Analytics categories, including all rules that make up each category. To get detailed
        information about a specific Call Analytics category, use the operation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ListCallAnalyticsCategoriesResponse'
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.ListCallAnalyticsCategories
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/ListCallAnalyticsCategoriesRequest'
      tags:
      - Call Analytics Category
  /#UpdateCallAnalyticsCategory:
    post:
      operationId: UpdateCallAnalyticsCategory
      summary: Update Call Analytics Category
      description: Updates the specified Call Analytics category with new rules. Note that the UpdateCallAnalyticsCategory
        operation overwrites all existing rules contained in the specified category. You cannot append additional rules onto
        an existing category. To create a new category, see .
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateCallAnalyticsCategoryResponse'
        '400':
          description: BadRequestException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/BadRequestException'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ConflictException'
        '500':
          description: InternalFailureException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/InternalFailureException'
        '429':
          description: LimitExceededException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
        '404':
          description: NotFoundException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/NotFoundException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - Transcribe.UpdateCallAnalyticsCategory
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateCallAnalyticsCategoryRequest'
      tags:
      - Call Analytics Category
components:
  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: transcribe
  schemas:
    AbsoluteTimeRange:
      type: object
      properties:
        StartTime:
          type: integer
          description: The time, in milliseconds, when Amazon Transcribe starts searching for the specified criteria in your
            audio. If you include StartTime in your request, you must also include EndTime.
        EndTime:
          type: integer
          description: The time, in milliseconds, when Amazon Transcribe stops searching for the specified criteria in your
            audio. If you include EndTime in your request, you must also include StartTime.
        First:
          type: integer
          description: The time, in milliseconds, from the start of your media file until the specified value. Amazon Transcribe
            searches for your specified criteria in this time segment.
        Last:
          type: integer
          description: The time, in milliseconds, from the specified value until the end of your media file. Amazon Transcribe
            searches for your specified criteria in this time segment.
    BadRequestException:
      type: object
      properties:
        Message:
          type: string
    CategoryProperties:
      type: object
      properties:
        CategoryName:
          type: string
          description: The name of the Call Analytics category. Category names are case sensitive and must be unique within
            an Amazon Web Services account.
        Rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          description: The rules used to define a Call Analytics category. Each category can have between 1 and 20 rules.
        CreateTime:
          type: string
          format: date-time
          description: The date and time the specified Call Analytics category was created. Timestamps are in the format YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC.
            For example, 2022-05-04T12:32:58.761000-07:00 represents 12:32 PM UTC-7 on May 4, 2022.
        LastUpdateTime:
          type: string
          format: date-time
          description: The date and time the specified Call Analytics category was last updated. Timestamps are in the format
            YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC. For example, 2022-05-05T12:45:32.691000-07:00 represents 12:45 PM UTC-7 on May
            5, 2022.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags, each in the form of a key:value pair, assigned to the specified call analytics category.
        InputType:
          type: string
          enum:
          - REAL_TIME
          - POST_CALL
          description: The input type associated with the specified category. POST_CALL refers to a category that is applied
            to batch transcriptions; REAL_TIME refers to a category that is applied to streaming transcriptions.
    ConflictException:
      type: object
      properties:
        Message:
          type: string
    CreateCallAnalyticsCategoryRequest:
      type: object
      properties:
        CategoryName:
          type: string
          description: A unique name, chosen by you, for your Call Analytics category. It's helpful to use a detailed naming
            system that will make sense to you in the future. For example, it's better to use sentiment-positive-last30seconds
            for a category over a generic name like test-category. Category names are case sensitive.
        Rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          description: Rules define a Call Analytics category. When creating a new category, you must create between 1 and
            20 rules for that category. For each rule, you specify a filter you want applied to the attributes of a call.
            For example, you can choose a sentiment filter that detects if a customer's sentiment was positive during the
            last 30 seconds of the call.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: Adds one or more custom tags, each in the form of a key:value pair, to a new call analytics category
            at the time you start this new job. To learn more about using tags with Amazon Transcribe, refer to Tagging resources.
        InputType:
          type: string
          enum:
          - REAL_TIME
          - POST_CALL
          description: Choose whether you want to create a real-time or a post-call category for your Call Analytics transcription.
            Specifying POST_CALL assigns your category to post-call transcriptions; categories with this input type cannot
            be applied to streaming (real-time) transcriptions. Specifying REAL_TIME assigns your category to streaming transcriptions;
            categories with this input type cannot be applied to post-call transcriptions. If you do not include InputType,
            your category is created as a post-call category by default.
      required:
      - CategoryName
      - Rules
    CreateCallAnalyticsCategoryResponse:
      type: object
      properties:
        CategoryProperties:
          $ref: '#/components/schemas/CategoryProperties'
    DeleteCallAnalyticsCategoryRequest:
      type: object
      properties:
        CategoryName:
          type: string
          description: The name of the Call Analytics category you want to delete. Category names are case sensitive.
      required:
      - CategoryName
    DeleteCallAnalyticsCategoryResponse:
      type: object
      properties: {}
    GetCallAnalyticsCategoryRequest:
      type: object
      properties:
        CategoryName:
          type: string
          description: The name of the Call Analytics category you want information about. Category names are case sensitive.
      required:
      - CategoryName
    GetCallAnalyticsCategoryResponse:
      type: object
      properties:
        CategoryProperties:
          $ref: '#/components/schemas/CategoryProperties'
    InternalFailureException:
      type: object
      properties:
        Message:
          type: string
    InterruptionFilter:
      type: object
      properties:
        Threshold:
          type: integer
          description: Specify the duration of the interruptions in milliseconds. For example, you can flag speech that contains
            more than 10,000 milliseconds of interruptions.
        ParticipantRole:
          type: string
          enum:
          - AGENT
          - CUSTOMER
          description: Specify the interrupter that you want to flag. Omitting this parameter is equivalent to specifying
            both participants.
        AbsoluteTimeRange:
          $ref: '#/components/schemas/AbsoluteTimeRange'
        RelativeTimeRange:
          $ref: '#/components/schemas/RelativeTimeRange'
        Negate:
          type: boolean
          description: Set to TRUE to flag speech that does not contain interruptions. Set to FALSE to flag speech that contains
            interruptions.
    LimitExceededException:
      type: object
      properties:
        Message:
          type: string
    ListCallAnalyticsCategoriesRequest:
      type: object
      properties:
        NextToken:
          type: string
          description: If your ListCallAnalyticsCategories request returns more results than can be displayed, NextToken is
            displayed in the response with an associated string. To get the next page of results, copy this string and repeat
            your request, including NextToken with the value of the copied string. Repeat as needed to view all your results.
        MaxResults:
          type: integer
          description: The maximum number of Call Analytics categories to return in each page of results. If there are fewer
            results than the value that you specify, only the actual results are returned. If you do not specify a value,
            a default of 5 is used.
    ListCallAnalyticsCategoriesResponse:
      type: object
      properties:
        NextToken:
          type: string
          description: If NextToken is present in your response, it indicates that not all results are displayed. To view
            the next set of results, copy the string associated with the NextToken parameter in your results output, then
            run your request again including NextToken with the value of the copied string. Repeat as needed to view all your
            results.
        Categories:
          type: array
          items:
            $ref: '#/components/schemas/CategoryProperties'
          description: Provides detailed information about your Call Analytics categories, including all the rules associated
            with each category.
    NonTalkTimeFilter:
      type: object
      properties:
        Threshold:
          type: integer
          description: Specify the duration, in milliseconds, of the period of silence that you want to flag. For example,
            you can flag a silent period that lasts 30,000 milliseconds.
        AbsoluteTimeRange:
          $ref: '#/components/schemas/AbsoluteTimeRange'
        RelativeTimeRange:
          $ref: '#/components/schemas/RelativeTimeRange'
        Negate:
          type: boolean
          description: Set to TRUE to flag periods of speech. Set to FALSE to flag periods of silence
    NotFoundException:
      type: object
      properties:
        Message:
          type: string
    RelativeTimeRange:
      type: object
      properties:
        StartPercentage:
          type: integer
          description: The time, in percentage, when Amazon Transcribe starts searching for the specified criteria in your
            media file. If you include StartPercentage in your request, you must also include EndPercentage.
        EndPercentage:
          type: integer
          description: The time, in percentage, when Amazon Transcribe stops searching for the specified criteria in your
            media file. If you include EndPercentage in your request, you must also include StartPercentage.
        First:
          type: integer
          description: The time, in percentage, from the start of your media file until the specified value. Amazon Transcribe
            searches for your specified criteria in this time segment.
        Last:
          type: integer
          description: The time, in percentage, from the specified value until the end of your media file. Amazon Transcribe
            searches for your specified criteria in this time segment.
    Rule:
      type: object
      properties:
        NonTalkTimeFilter:
          $ref: '#/components/schemas/NonTalkTimeFilter'
        InterruptionFilter:
          $ref: '#/components/schemas/InterruptionFilter'
        TranscriptFilter:
          $ref: '#/components/schemas/TranscriptFilter'
        SentimentFilter:
          $ref: '#/components/schemas/SentimentFilter'
      description: Exactly one member is set.
    SentimentFilter:
      type: object
      properties:
        Sentiments:
          type: array
          items:
            type: string
            enum:
            - POSITIVE
            - NEGATIVE
            - NEUTRAL
            - MIXED
          description: Specify the sentiments that you want to flag.
        AbsoluteTimeRange:
          $ref: '#/components/schemas/AbsoluteTimeRange'
        RelativeTimeRange:
          $ref: '#/components/schemas/RelativeTimeRange'
        ParticipantRole:
          type: string
          enum:
          - AGENT
          - CUSTOMER
          description: Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying
            both participants.
        Negate:
          type: boolean
          description: Set to TRUE to flag the sentiments that you didn't include in your request. Set to FALSE to flag the
            sentiments that you specified in your request.
      required:
      - Sentiments
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: The first part of a key:value pair that forms a tag associated with a given resource. For example,
            in the tag Department:Sales, the key is 'Department'.
        Value:
          type: string
          description: The second part of a key:value pair that forms a tag associated with a given resource. For example,
            in the tag Department:Sales, the value is 'Sales'. Note that you can set the value of a tag to an empty string,
            but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.
      required:
      - Key
      - Value
    TranscriptFilter:
      type: object
      properties:
        TranscriptFilterType:
          type: string
          enum:
          - EXACT
          description: Flag the presence or absence of an exact match to the phrases that you specify. For example, if you
            specify the phrase "speak to a manager" as your Targets value, only that exact phrase is flagged. Note that semantic
            matching is not supported. For example, if your customer says "speak to the manager", instead of "speak to a manager",
            your content is not flagged.
        AbsoluteTimeRange:
          $ref: '#/components/schemas/AbsoluteTimeRange'
        RelativeTimeRange:
          $ref: '#/components/schemas/RelativeTimeRange'
        ParticipantRole:
          type: string
          enum:
          - AGENT
          - CUSTOMER
          description: Specify the participant that you want to flag. Omitting this parameter is equivalent to specifying
            both participants.
        Negate:
          type: boolean
          description: Set to TRUE to flag the absence of the phrase that you specified in your request. Set to FALSE to flag
            the presence of the phrase that you specified in your request.
        Targets:
          type: array
          items:
            type: string
          description: Specify the phrases that you want to flag.
      required:
      - TranscriptFilterType
      - Targets
    UpdateCallAnalyticsCategoryRequest:
      type: object
      properties:
        CategoryName:
          type: string
          description: The name of the Call Analytics category you want to update. Category names are case sensitive.
        Rules:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
          description: The rules used for the updated Call Analytics category. The rules you provide in this field replace
            the ones that are currently being used in the specified category.
        InputType:
          type: string
          enum:
          - REAL_TIME
          - POST_CALL
          description: Choose whether you want to update a real-time or a post-call category. The input type you specify must
            match the input type specified when the category was created. For example, if you created a category with the
            POST_CALL input type, you must use POST_CALL as the input type when updating this category.
      required:
      - CategoryName
      - Rules
    UpdateCallAnalyticsCategoryResponse:
      type: object
      properties:
        CategoryProperties:
          $ref: '#/components/schemas/CategoryProperties'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/transcribe/service/2017-10-26/transcribe-2017-10-26.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)