Skip to content

docs(amazon-bedrock): add API key authentication documentation #9359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+27 −4
Open

docs(amazon-bedrock): add API key authentication documentation #9359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2488c79
docs(amazon-bedrock): add API key authentication documentation
zapagenrevdale Oct 10, 2025
cc4a4bc
docs(amazon-bedrock): fix README to use createAmazonBedrock instead o…
zapagenrevdale Oct 10, 2025
eca01b9
Merge branch 'main' into main
zapagenrevdale Oct 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions content/providers/01-ai-sdk-providers/08-amazon-bedrock.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,18 @@ See the [Model Access Docs](https://docs.aws.amazon.com/bedrock/latest/userguide

### Authentication

The Amazon Bedrock provider supports API key authentication and AWS credentials (IAM/SigV4). API keys are recommended for simpler setup.

#### Using API Key (Recommended)

Set the `AWS_BEARER_TOKEN_BEDROCK` environment variable:

```makefile
AWS_BEARER_TOKEN_BEDROCK=your-api-key-here
```

The API key will be automatically used. If not provided, the provider falls back to AWS credentials.

#### Using IAM Access Key and Secret Key

**Step 1: Creating AWS Access Key and Secret Key**
Expand Down Expand Up @@ -124,6 +136,13 @@ If you need a customized setup, you can import `createAmazonBedrock` from `@ai-s
```ts
import { createAmazonBedrock } from '@ai-sdk/amazon-bedrock';

// With API key:
const bedrock = createAmazonBedrock({
apiKey: 'your-api-key',
region: 'us-east-1',
});

// Or with IAM credentials:
const bedrock = createAmazonBedrock({
region: 'us-east-1',
accessKeyId: 'xxxxxxxxx',
Expand All @@ -143,6 +162,10 @@ const bedrock = createAmazonBedrock({

You can use the following optional settings to customize the Amazon Bedrock provider instance:

- **apiKey** _string_

The API key for authentication. It uses the `AWS_BEARER_TOKEN_BEDROCK` environment variable by default. When provided, this takes precedence over AWS credentials.

- **region** _string_

The AWS region that you want to use for the API calls.
Expand Down
8 changes: 4 additions & 4 deletions packages/amazon-bedrock/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ const { text } = await generateText({

#### Using Direct Configuration

You can also pass the API key directly in the provider configuration:
You can also pass the API key directly when creating a custom provider instance:

```ts
import { bedrock } from '@ai-sdk/amazon-bedrock';
import { createAmazonBedrock } from '@ai-sdk/amazon-bedrock';
import { generateText } from 'ai';

const bedrockWithApiKey = bedrock.withSettings({
const bedrockWithApiKey = createAmazonBedrock({
apiKey: process.env.AWS_BEARER_TOKEN_BEDROCK, // or your API key directly
region: 'us-east-1', // Optional: specify region
});
Expand Down Expand Up @@ -90,7 +90,7 @@ This method requires standard AWS environment variables:

The provider uses the following authentication precedence:

1. **API key from direct configuration** (`apiKey` in `withSettings()`)
1. **API key from direct configuration** (`apiKey` in `createAmazonBedrock()`)
2. **API key from environment variable** (`AWS_BEARER_TOKEN_BEDROCK`)
3. **SigV4 authentication** (AWS credential chain fallback)

Expand Down