> ## 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 outbound credential

> Store authentication for an external tool or webhook.

Requires Admin or Owner. Supply a unique name, credential type, and matching `credential_data`. Duplicate names return `409`; missing required credential fields return `400`. The response contains metadata and a UUID, not the stored secret.

| Type | Credential data |
| - | - |
| `none` | Empty object |
| `api_key` | `header_name`, `api_key` |
| `bearer_token` | `token` |
| `basic_auth` | `username`, `password` |
| `custom_header` | `header_name`, `header_value` |
| `oauth2_client_credentials` | `token_endpoint`, `client_id`, `client_secret` |

Supply credentials through your secret-management process. Do not place real secrets in shared examples or source control.


## OpenAPI

````yaml POST /api/v1/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/credentials/:
    post:
      tags:
        - credentials
      summary: Create an outbound credential
      description: >-
        **Authorization:** Requires an Admin or Owner role in the requested
        workspace.


        Store authentication for an external tool or webhook.
      operationId: create_credential_api_v1_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/CreateCredentialRequest'
            example:
              name: Order service
              credential_type: bearer_token
              credential_data:
                token: REPLACE_WITH_SERVICE_TOKEN
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialResponse'
          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
      security:
        - LabsAuth: []
        - LabsApiKey: []
components:
  schemas:
    CreateCredentialRequest:
      properties:
        credential_data:
          additionalProperties: true
          title: Credential Data
          type: object
        credential_type:
          $ref: '#/components/schemas/WebhookCredentialType'
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        name:
          title: Name
          type: string
      required:
        - name
        - credential_type
        - credential_data
      title: CreateCredentialRequest
      type: object
    CredentialResponse:
      properties:
        created_at:
          format: date-time
          title: Created At
          type: string
        credential_type:
          title: Credential Type
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        name:
          title: Name
          type: string
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Updated At
        uuid:
          title: Uuid
          type: string
      required:
        - uuid
        - name
        - description
        - credential_type
        - created_at
        - updated_at
      title: CredentialResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    WebhookCredentialType:
      enum:
        - none
        - api_key
        - bearer_token
        - basic_auth
        - custom_header
        - oauth2_client_credentials
      title: WebhookCredentialType
      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.