Skip to main content
POST
Related guide: Private models guide. See the Private models guide for a walkthrough with examples.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
auth_mode
enum<string>
required

Where the AWS credentials come from. integration reads static AWS access keys from the integration named by integration_id, which is required with it. pod-identity resolves credentials from the AWS default credential chain of the deployment, such as EKS Pod Identity, IAM Roles for Service Accounts or the instance metadata service, and ignores integration_id; set assume_role_arn to assume a role in another account and assume_role_external_id to pass the external ID that role's trust policy requires.

Available options:
integration,
pod-identity
display_name
string
required
Maximum string length: 128
model_developer
string
required

Developer of the model behind the inference profile, such as anthropic or amazon.

model_id
string
required

Bedrock inference profile ARN to invoke, for example arn:aws:bedrock:us-east-1:123456789012:inference-profile/anthropic.claude-3-sonnet-20240229-v1:0. When configuration.model_id is supplied, this field is instead the immutable workspace-unique slug and the ARN comes from configuration.model_id.

region
string
required

AWS region that serves the inference profile, such as us-east-1.

assume_role_arn
string
assume_role_external_id
string
autorouter_id
string

Smart Router catalog identifier of the model. Set it together with autorouter_version to make the private model eligible for Smart Router pools.

autorouter_version
string

Version of the Smart Router catalog entry, set with autorouter_id.

benchmark_model
string
cache_read_cost
number<double>
cache_write_cost
number<double>
configuration
object
description
string
has_reasoning
boolean
input_cost
number<double>
integration_id
string
max_tokens
integer<int64>
model_family
string
model_type
string
output_cost
number<double>
supports_adaptive_reasoning
boolean
supports_extended_thinking
boolean
supports_json_mode
boolean
supports_json_schema
boolean
supports_mid_conversation_system
boolean
supports_strict_tool
boolean
supports_tool_calling
boolean
supports_vision
boolean
temperature
number<double>

Response

AWS Bedrock model created successfully

configuration
object
required
created
string
required
description
string | null
required
display_name
string
required
docs_url
string | null
required
enabled
boolean
required
enabled_for_endpoints
boolean
required
enabled_for_playground
boolean
required
has_cpu_pricing
boolean
required
has_functions
boolean
required
id
string
required
input_cost
number<double> | null
required
input_currency
string
required
is_active
boolean
required
metadata
object
required
model_id
string
required
model_type
string
required
output_cost
number<double> | null
required
output_currency
string
required
owner
string
required
parameters
object[] | null
required
pricing_url
string | null
required
provider
string
required
refId
string
required

Reference the gateway accepts for this model in requests: provider/model_id, or workspace@provider/model_id for a private model.

updated
string
required
legacy_uuid
string
deprecated

Identifier this model had in the legacy model catalog. Deprecated: use id.

model_developer
string
model_family
string
sharing
object