> ## Documentation Index
> Fetch the complete documentation index at: https://docs.agents.labs.bandwidth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an AI credential

> Store an AI-provider credential for the workspace.

Requires Admin or Owner. Successful creation returns **201 Created** with credential metadata. A duplicate name returns `409`, invalid input `400`, and unavailable credential storage `503`. Do not put real provider credentials in shared examples.


## OpenAPI

````yaml POST /api/v1/user/configurations/credentials
openapi: 3.1.0
info:
  title: Bandwidth Agent Builder API
  version: v1
  description: >-
    Manage agents, place calls, and retrieve conversation results in your
    workspace.
servers:
  - url: https://agents.labs.bandwidth.com
    description: Workspace API
security: []
paths:
  /api/v1/user/configurations/credentials:
    post:
      tags:
        - ai-connections
      summary: Create an AI credential
      description: >-
        **Authorization:** Requires an Admin or Owner role in the requested
        workspace.


        Store an AI-provider credential for the workspace.
      operationId: add_ai_credential_api_v1_user_configurations_credentials_post
      parameters:
        - description: >-
            Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace
            ID to access. The key owner must be a current member. Missing or
            invalid IDs return 400; non-member workspaces return 403. Not
            required for bearer authentication, which uses the user's selected
            workspace.
          in: header
          name: X-VOAI-ORGANIZATION-ID
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Required with X-BW-LABS-AGENTS-API-KEY: the positive local
              workspace ID to access. The key owner must be a current member.
              Missing or invalid IDs return 400; non-member workspaces return
              403. Not required for bearer authentication, which uses the user's
              selected workspace.
            title: X-Voai-Organization-Id
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAICredentialRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AICredentialResponse'
          description: Successful Response
        '400':
          description: Invalid request or missing/invalid workspace header with an API key.
        '401':
          description: Missing, invalid, or expired credential.
        '403':
          description: >-
            The account lacks access to the workspace, resource, or required
            role.
        '404':
          description: Not found
        '409':
          description: Credential name is already in use.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
        '503':
          description: Credential storage is unavailable.
      security:
        - LabsAuth: []
        - LabsApiKey: []
components:
  schemas:
    CreateAICredentialRequest:
      properties:
        api_key:
          anyOf:
            - format: password
              type: string
              writeOnly: true
            - type: 'null'
          title: Api Key
        aws_access_key:
          anyOf:
            - format: password
              type: string
              writeOnly: true
            - type: 'null'
          title: Aws Access Key
        aws_secret_key:
          anyOf:
            - format: password
              type: string
              writeOnly: true
            - type: 'null'
          title: Aws Secret Key
        aws_session_token:
          anyOf:
            - format: password
              type: string
              writeOnly: true
            - type: 'null'
          title: Aws Session Token
        name:
          maxLength: 100
          minLength: 1
          title: Name
          type: string
        provider:
          $ref: '#/components/schemas/ServiceProviders'
      required:
        - name
        - provider
      title: CreateAICredentialRequest
      type: object
    AICredentialResponse:
      properties:
        id:
          title: Id
          type: string
        name:
          title: Name
          type: string
        provider:
          $ref: '#/components/schemas/ServiceProviders'
      required:
        - id
        - name
        - provider
      title: AICredentialResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ServiceProviders:
      enum:
        - anthropic
        - openai
        - deepgram
        - groq
        - openrouter
        - cartesia
        - elevenlabs
        - google
        - azure
        - azure_speech
        - sarvam
        - speechmatics
        - camb
        - aws_bedrock
        - speaches
        - bandwidth
        - assemblyai
        - gladia
        - rime
        - minimax
        - xai
        - google_vertex
        - openai_realtime
        - grok_realtime
        - ultravox_realtime
        - google_realtime
        - google_vertex_realtime
        - azure_realtime
      title: ServiceProviders
      type: string
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    LabsAuth:
      description: >-
        Bandwidth Labs OAuth access token. Uses the user's selected workspace;
        the workspace header is not required. Do not also send an API key.
        Bearer-only operations may additionally require the Labs `super_user`
        role.
      scheme: bearer
      type: http
    LabsApiKey:
      description: >-
        Bandwidth Labs API key. Also send `X-VOAI-ORGANIZATION-ID` with a
        positive local workspace ID belonging to the key owner. Access follows
        the owner's current workspace role. Do not also send a bearer token. API
        keys cannot access bearer-only or Labs `super_user` operations.
      in: header
      name: X-BW-LABS-AGENTS-API-KEY
      type: apiKey

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.