Amazon Chime SDK Chime Voice Profiles API

The Chime Voice Profiles API from Amazon Chime SDK — 2 operation(s) for chime voice profiles.

GitHub OpenAPI

Operations 5

POST /voice-profiles Create Voice Profile #
GET /voice-profiles List Voice Profiles #
DELETE /voice-profiles/{VoiceProfileId} Delete Voice Profile #
GET /voice-profiles/{VoiceProfileId} Get Voice Profile #
PUT /voice-profiles/{VoiceProfileId} Update Voice Profile #

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-profiles-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-profiles-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon Chime SDK Meetings Voice Profiles API
  version: '2021-07-15'
  description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 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://voice-chime.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /voice-profiles:
    post:
      operationId: CreateVoiceProfile
      summary: Create Voice Profile
      description: Creates a voice profile, which consists of an enrolled user and their latest voice print. Before creating
        any voice profiles, 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. For more information
        about voice profiles and voice analytics, see Using Amazon Chime SDK Voice Analytics in the Amazon Chime SDK Developer
        Guide.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateVoiceProfileResponse'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVoiceProfileRequest'
      tags:
      - Voice Profiles
    get:
      operationId: ListVoiceProfiles
      summary: List Voice Profiles
      description: Lists the voice profiles in a voice profile domain.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListVoiceProfilesResponse'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '403':
          description: ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeForbiddenException'
        '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/ListVoiceProfilesRequest'
      tags:
      - Voice Profiles
  /voice-profiles/{VoiceProfileId}:
    delete:
      operationId: DeleteVoiceProfile
      summary: Delete Voice Profile
      description: 'Deletes a voice profile, including its voice print and enrollment data. WARNING: This action is not reversible.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: string
        '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/DeleteVoiceProfileRequest'
      tags:
      - Voice Profiles
    get:
      operationId: GetVoiceProfile
      summary: Get Voice Profile
      description: Retrieves the details of the specified voice profile.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVoiceProfileResponse'
        '403':
          description: AccessDeniedException; ForbiddenException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '400':
          description: BadRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceChimeBadRequestException'
        '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/GetVoiceProfileRequest'
      tags:
      - Voice Profiles
    put:
      operationId: UpdateVoiceProfile
      summary: Update Voice Profile
      description: Updates the specified voice profile’s voice print and refreshes its expiration timestamp. As a condition
        of using this feature, you acknowledge that the collection, use, storage, and retention of your caller’s biometric
        identifiers and biometric information (“biometric data”) in the form of a digital voiceprint requires the caller’s
        informed consent via a written release. Such consent is required under various state laws, including biometrics laws
        in Illinois, Texas, Washington and other state privacy laws. You must provide a written release to each caller through
        a process that clearly reflects each caller’s informed consent before using Amazon Chime SDK Voice Insights service,
        as required under the terms of your agreement with AWS governing your use of the service.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateVoiceProfileResponse'
        '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'
        '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'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVoiceProfileRequest'
      tags:
      - Voice Profiles
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
    CreateVoiceProfileRequest:
      type: object
      properties:
        SpeakerSearchTaskId:
          type: string
          description: The ID of the speaker search task.
      required:
      - SpeakerSearchTaskId
    CreateVoiceProfileResponse:
      type: object
      properties:
        VoiceProfile:
          $ref: '#/components/schemas/VoiceProfile'
    DeleteVoiceProfileRequest:
      type: object
      properties:
        VoiceProfileId:
          type: string
          description: The voice profile ID.
      required:
      - VoiceProfileId
    GetVoiceProfileRequest:
      type: object
      properties:
        VoiceProfileId:
          type: string
          description: The voice profile ID.
      required:
      - VoiceProfileId
    GetVoiceProfileResponse:
      type: object
      properties:
        VoiceProfile:
          $ref: '#/components/schemas/VoiceProfile'
    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
    ListVoiceProfilesRequest:
      type: object
      properties:
        VoiceProfileDomainId:
          type: string
          description: The ID of the voice profile domain.
        NextToken:
          type: string
          description: The token used to retrieve the next page of results.
        MaxResults:
          type: integer
          description: The maximum number of results in the request.
      required:
      - VoiceProfileDomainId
    ListVoiceProfilesResponse:
      type: object
      properties:
        VoiceProfiles:
          type: array
          items:
            $ref: '#/components/schemas/VoiceProfileSummary'
          description: The list of voice profiles.
        NextToken:
          type: string
          description: The token used to retrieve the next page of results.
    UpdateVoiceProfileRequest:
      type: object
      properties:
        VoiceProfileId:
          type: string
          description: The profile ID.
        SpeakerSearchTaskId:
          type: string
          description: The ID of the speaker search task.
      required:
      - VoiceProfileId
      - SpeakerSearchTaskId
    UpdateVoiceProfileResponse:
      type: object
      properties:
        VoiceProfile:
          $ref: '#/components/schemas/VoiceProfile'
    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
    VoiceChimeForbiddenException:
      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
    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
    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
    VoiceProfile:
      type: object
      properties:
        VoiceProfileId:
          type: string
          description: The ID of the voice profile.
        VoiceProfileArn:
          type: string
          description: The ARN of the voice profile.
        VoiceProfileDomainId:
          type: string
          description: The ID of the domain that contains the voice profile.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which the voice profile was created and enrolled.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which the voice profile was last updated.
        ExpirationTimestamp:
          type: string
          format: date-time
          description: The time at which a voice profile expires unless you re-enroll the caller via the UpdateVoiceProfile
            API.
    VoiceProfileSummary:
      type: object
      properties:
        VoiceProfileId:
          type: string
          description: The ID of the voice profile in a voice profile summary.
        VoiceProfileArn:
          type: string
          description: The ARN of the voice profile in a voice profile summary.
        VoiceProfileDomainId:
          type: string
          description: The ID of the voice profile domain in a voice profile summary.
        CreatedTimestamp:
          type: string
          format: date-time
          description: The time at which a voice profile summary was created.
        UpdatedTimestamp:
          type: string
          format: date-time
          description: The time at which a voice profile summary was last updated.
        ExpirationTimestamp:
          type: string
          format: date-time
          description: Extends the life of the voice profile. You can use UpdateVoiceProfile to refresh an existing voice
            profile's voice print and extend the life of the summary.
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-voice/service/2022-08-03/chime-sdk-voice-2022-08-03.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)