Skip to content

Commit 1566b0e

Browse files
author
Verso Labs
committed
docs(bedrock): clarify Mantle model-family routes
1 parent 66688d6 commit 1566b0e

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

bedrock/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,22 @@ Use the `bedrock` package to configure the normal OpenAI client for Amazon Bedro
99

1010
Runtime hostnames use the correct suffix for the selected AWS partition. Canonical Runtime, FIPS, and dual-stack `BaseURL` overrides automatically select the endpoint family when `Endpoint` is omitted. Canonical AWS hosts must use HTTPS and match the configured region and endpoint. Custom or proxy hosts default to the Mantle signer; set `EndpointRuntime` explicitly when a custom host requires Runtime signing.
1111

12+
### Mantle API roots
13+
14+
Amazon Bedrock exposes more than one OpenAI-compatible API root on `bedrock-mantle`, and the route depends on the model family. OpenAI model pages such as [GPT-5.5](https://docs.aws.amazon.com/bedrock/latest/userguide/model-card-openai-gpt-55.html) document `/openai/v1`, while other model pages such as [Kimi K2.5](https://docs.aws.amazon.com/bedrock/latest/userguide/model-card-moonshot-ai-kimi-k2-5.html) document `/v1`. `EndpointMantle` keeps `/openai/v1` as its default for backwards compatibility; choosing `EndpointMantle` does not automatically select a route from the model name.
15+
16+
When the AWS model card for a deployment documents `/v1`, set the Mantle `BaseURL` explicitly:
17+
18+
```go
19+
bedrock.Config{
20+
Endpoint: bedrock.EndpointMantle,
21+
AWSRegion: "us-east-1",
22+
BaseURL: "https://bedrock-mantle.us-east-1.api.aws/v1",
23+
}
24+
```
25+
26+
See the AWS model card for the model you are using before choosing the route. For example, AWS documents `https://bedrock-mantle.<region>.api.aws/openai/v1` for GPT-5.5 and `https://bedrock-mantle.<region>.api.aws/v1` for Kimi K2.5.
27+
1228
## Runtime Chat Completions
1329

1430
```go

0 commit comments

Comments
 (0)