Amazon Chime SDK Chime Voice Tone Analysis Tasks API

The Chime Voice Tone Analysis Tasks API from Amazon Chime SDK — 4 operation(s) for chime voice tone analysis tasks.

GitHub OpenAPI

Operations 4

GET /media-insights-pipelines/{Identifier}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId} Get Voice Tone Analysis Task #
POST /media-insights-pipelines/{Identifier}/voice-tone-analysis-tasks?operation=start Start Voice Tone Analysis Task #
GET /voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId} Get Voice Tone Analysis Task #
POST /voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks Start Voice Tone Analysis Task #

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-chime:amazon-chime-voice-tone-analysis-tasks-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.

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

OpenAPI Specification

amazon-chime-voice-tone-analysis-tasks-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Voice Tone Analysis Tasks API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 4 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://media-pipelines-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /media-insights-pipelines/{Identifier}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}:
    get:
      operationId: GetVoiceToneAnalysisTask
      summary: Get Voice Tone Analysis Task
      description: Retrieves the details of a voice tone analysis task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVoiceToneAnalysisTaskResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetVoiceToneAnalysisTaskRequest'
      tags:
      - Voice Tone Analysis Tasks
  /media-insights-pipelines/{Identifier}/voice-tone-analysis-tasks?operation=start:
    post:
      operationId: StartVoiceToneAnalysisTask
      summary: Start Voice Tone Analysis Task
      description: Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime
        SDK voice analytics in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must
        provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws,
        and as required under the AWS service terms for the Amazon Chime SDK.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartVoiceToneAnalysisTaskResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeConflictException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeForbiddenException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediaPipelinesChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartVoiceToneAnalysisTaskRequest'
      tags:
      - Voice Tone Analysis Tasks
  /voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks/{VoiceToneAnalysisTaskId}:
    get:
      operationId: GetVoiceToneAnalysisTask
      summary: Get Voice Tone Analysis Task
      description: Retrieves the details of a voice tone analysis task.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVoiceToneAnalysisTaskResponse'
        '403':
          description: AccessDeniedException; ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeConflictException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoiceChimeGetVoiceToneAnalysisTaskRequest'
      tags:
      - Voice Tone Analysis Tasks
      servers:
      - url: https://voice-chime.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
  /voice-connectors/{VoiceConnectorId}/voice-tone-analysis-tasks:
    post:
      operationId: StartVoiceToneAnalysisTask
      summary: Start Voice Tone Analysis Task
      description: Starts a voice tone analysis task. For more information about voice tone analysis, see Using Amazon Chime
        SDK voice analytics in the Amazon Chime SDK Developer Guide. Before starting any voice tone analysis tasks, you must
        provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws,
        and as required under the AWS service terms for the Amazon Chime SDK.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartVoiceToneAnalysisTaskResponse'
        '403':
          description: AccessDeniedException; ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException; ResourceLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '409':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeConflictException'
        '410':
          description: GoneException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GoneException'
        '404':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeNotFoundException'
        '500':
          description: ServiceFailureException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceFailureException'
        '503':
          description: ServiceUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeServiceUnavailableException'
        '429':
          description: ThrottledClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeThrottledClientException'
        '401':
          description: UnauthorizedClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnauthorizedClientException'
        '422':
          description: UnprocessableEntityException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeUnprocessableEntityException'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoiceChimeStartVoiceToneAnalysisTaskRequest'
      tags:
      - Voice Tone Analysis Tasks
      servers:
      - url: https://voice-chime.{region}.amazonaws.com
        variables:
          region:
            default: us-east-1
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: chime
  schemas:
    AccessDeniedException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    GetVoiceToneAnalysisTaskRequest:
      type: object
      properties:
        Identifier:
          type: string
          description: The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media
            insights pipeline.
        VoiceToneAnalysisTaskId:
          type: string
          description: The ID of the voice tone analysis task.
      required:
      - Identifier
      - VoiceToneAnalysisTaskId
    GetVoiceToneAnalysisTaskResponse:
      type: object
      properties:
        VoiceToneAnalysisTask:
          $ref: '#/components/schemas/VoiceToneAnalysisTask'
    GoneException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    KinesisVideoStreamSourceTaskConfiguration:
      type: object
      properties:
        StreamArn:
          type: string
          description: The ARN of the stream.
        ChannelId:
          type: integer
          description: The channel ID.
        FragmentNumber:
          type: string
          description: The unique identifier of the fragment to begin processing.
      required:
      - StreamArn
      - ChannelId
    MediaPipelinesChimeBadRequestException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeConflictException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeForbiddenException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request id associated with the call responsible for the exception.
    MediaPipelinesChimeNotFoundException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeServiceFailureException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeThrottledClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    MediaPipelinesChimeUnauthorizedClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Forbidden
          - NotFound
          - ResourceLimitExceeded
          - ServiceFailure
          - ServiceUnavailable
          - Throttling
        Message:
          type: string
        RequestId:
          type: string
          description: The request ID associated with the call responsible for the exception.
    StartVoiceToneAnalysisTaskRequest:
      type: object
      properties:
        Identifier:
          type: string
          description: The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media
            insights pipeline.
        LanguageCode:
          type: string
          enum:
          - en-US
          description: The language code.
        KinesisVideoStreamSourceTaskConfiguration:
          $ref: '#/components/schemas/KinesisVideoStreamSourceTaskConfiguration'
        ClientRequestToken:
          type: string
          description: The unique identifier for the client request. Use a different token for different voice tone analysis
            tasks.
      required:
      - Identifier
      - LanguageCode
    StartVoiceToneAnalysisTaskResponse:
      type: object
      properties:
        VoiceToneAnalysisTask:
          $ref: '#/components/schemas/VoiceToneAnalysisTask'
    VoiceChimeBadRequestException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeConflictException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeGetVoiceToneAnalysisTaskRequest:
      type: object
      properties:
        VoiceConnectorId:
          type: string
          description: The Voice Connector ID.
        VoiceToneAnalysisTaskId:
          type: string
          description: The ID of the voice tone analysis task.
        IsCaller:
          type: boolean
          description: Specifies whether the voice being analyzed is the caller (originator) or the callee (responder).
      required:
      - VoiceConnectorId
      - VoiceToneAnalysisTaskId
      - IsCaller
    VoiceChimeNotFoundException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeServiceFailureException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeServiceUnavailableException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeStartVoiceToneAnalysisTaskRequest:
      type: object
      properties:
        VoiceConnectorId:
          type: string
          description: The Voice Connector ID.
        TransactionId:
          type: string
          description: The transaction ID.
        LanguageCode:
          type: string
          enum:
          - en-US
          description: The language code.
        ClientRequestToken:
          type: string
          description: The unique identifier for the client request. Use a different token for different voice tone analysis
            tasks.
      required:
      - VoiceConnectorId
      - TransactionId
      - LanguageCode
    VoiceChimeThrottledClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeUnauthorizedClientException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceChimeUnprocessableEntityException:
      type: object
      properties:
        Code:
          type: string
          enum:
          - BadRequest
          - Conflict
          - Forbidden
          - NotFound
          - PreconditionFailed
          - ResourceLimitExceeded
          - ServiceFailure
          - AccessDenied
          - ServiceUnavailable
          - Throttled
          - Throttling
          - Unauthorized
          - Unprocessable
          - VoiceConnectorGroupAssociationsExist
          - PhoneNumberAssociationsExist
          - Gone
          - Validation
        Message:
          type: string
    VoiceToneAnalysisTask:
      type: object
      properties:
        VoiceToneAnalysisTaskId:
          type: string
          description: The ID of the voice tone analysis task.
        VoiceToneAnalysisTaskStatus:
          type: string
          enum:
          - NotStarted
          - Initializing
          - InProgress
          - Failed
          - Stopping
          - Stopped
          description: The status of a voice tone analysis task.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which a voice tone analysis task was created.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which a voice tone analysis task was updated.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-media-pipelines/service/2021-07-15/chime-sdk-media-pipelines-2021-07-15.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)
  sources:
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-media-pipelines/service/2021-07-15/chime-sdk-media-pipelines-2021-07-15.json
  - https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json