---
title: "Create provider"
method: POST
path: "/v4/organizations/{organizationId}/aiServices/providers"
tags: ["AI Data Plane Providers"]
---

# Create provider

`POST /v4/organizations/{organizationId}/aiServices/providers`

## Request

- Base URL: `https://cloudapi.cloud.couchbase.com`
- URL: `https://cloudapi.cloud.couchbase.com/v4/organizations/{organizationId}/aiServices/providers`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/docs/v4/organizations/:organizationId/aiServices/providers/post.ts> (a function with typed inputs; its response is checked against the schema)

Creates a new integration for a given organization.

In order to access this endpoint, the provided API key must have at least one of the following roles:
- Organization Owner

To learn more, see [Organization, Project, and Database Access Overview](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html).

## Request body

- CreateProviderRequest
  - `type` 'awsS3' | 'openAI' | 'awsBedrock', required: The type of provider to create.
  - `name` string, required: The name for the provider integration to create.
  - `configuration` union, required: The configuration for the provider to create.
    - object
      - `accessKeyId` string, required: The access key ID to access the S3 bucket.
      - `secretAccessKey` string, required: The secret access key to access the S3 bucket.
      - `sessionToken` string: The session token to access the S3 bucket in case of temporary credentials.
      - `awsRegion` string, required: The AWS region the S3 bucket is located in.
      - `bucket` string, required: The name of the S3 bucket.
      - `folderPath` string: The path to the folder in the S3 bucket where the files are stored. Leave empty for root folder.
    - object
      - `apiKey` string, required: The API key to access the OpenAI API.
    - object: Configuration for AWS Bedrock provider. Supports two mutually exclusive authentication methods: 1. API Key authentication: Provide 'apiKey' and 'region' 2. IAM credentials authentication: Provide 'accessKeyId' and 'secretAccessKey' The authentication method is locked once the provider is created.
      - `accessKeyId` string: The AWS access key ID for IAM credentials authentication.
      - `secretAccessKey` string: The AWS secret access key for IAM credentials authentication.
      - `apiKey` string: The AWS Bedrock API key for API key authentication. Mutually exclusive with IAM credentials.
      - `region` 'us-east-1' | 'us-west-2' | 'ap-northeast-1' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'ap-south-2' | 'ap-southeast-1' | 'ap-southeast-2' | 'ca-central-1' | 'eu-central-1' | 'eu-central-2' | 'eu-north-1' | 'eu-south-1' | 'eu-south-2' | 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'sa-east-1': The AWS region for Bedrock. Required only for API key authentication.

## Response `201`

Successfully created a provider.

- CreateProviderResponse
  - `id` string, required: The ID of the created provider.

## Other responses

- `400`: Returned when we are unable to decode the recevied payload.
- `403`: The client does not have the necessary permissions to access this resource.
- `404`: The requested resource was not found.
- `422`: Request validation error.
- `429`: Returned when the client exceeds the rate limit for the given APIKey.
- `500`: An unexpected error occurred in the server while processing this request.

## Changes

- **2026-08-06** `e67df5d1f74e`: 6 info
  - api tag `AI Data Plane Providers` added
  - api tag `AI Services Providers` removed
  - added the new optional request property `configuration/oneOf[#/components/schemas/CreateBedrockConfigurationRequest]/apiKey`
  - added the new optional request property `configuration/oneOf[#/components/schemas/CreateBedrockConfigurationRequest]/region`
  - …2 more

[Operation history](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/changes/v4/organizations/:organizationId/aiServices/providers/post.md)

---

[API](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api.md) - [All operations](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/llms.txt) - [OpenAPI document](https://skmtc.dev/couchbase/apis/couchbase-capella-management-api/revisions/a5e88bcf71cb?raw)