GET /api/openapi.json; no token is needed to read it. Customer data and deployment operations still require authentication. The interactive reference is in the app.
Authenticated operations accept Authorization: Bearer $SPRINGWINTER_TOKEN. Cookie mutations require a CSRF token. Signed webhooks use their own signature checks. Read each operation’s security setting.
GET /api/projects/{project_id}/bedrock
List Bedrock models for a project
Lists on-demand foundation models in the project region, plus whether each selected model is available. Requires the customer role. Does not invoke a model.
{
"tags": [
"Bedrock"
],
"summary": "List Bedrock models for a project",
"description": "Lists on-demand foundation models in the project region, plus whether each selected model is available. Requires the customer role. Does not invoke a model.",
"operationId": "getProjectBedrock",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"use_case_submitted": {
"type": "boolean"
},
"gateway": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"id",
"status"
]
},
{
"type": "null"
}
]
},
"in_progress": {
"type": "boolean"
},
"models": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"type": "string"
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"inference_profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"agreement_required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"availability": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"model_id",
"name",
"provider",
"inference_profile_id",
"agreement_required",
"enabled",
"availability"
]
}
}
},
"required": [
"use_case_submitted",
"gateway",
"in_progress",
"models"
]
}
}
}
},
"422": {
"description": "missing_aws_account; missing_permissions",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"missing_aws_account",
"missing_permissions"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found"
]
}
},
"required": [
"error"
]
}
}
}
}
}
}
PUT /api/projects/{project_id}/bedrock
Save the models this project may call
Checks Bedrock and Marketplace permissions, records the selection, and starts bedrock-sync. Anthropic models need the use case form once per AWS account. Creating an agreement accepts that model’s license. Invoke stays on the project task roles. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.
{
"tags": [
"Bedrock"
],
"summary": "Save the models this project may call",
"description": "Checks Bedrock and Marketplace permissions, records the selection, and starts bedrock-sync. Anthropic models need the use case form once per AWS account. Creating an agreement accepts that model's license. Invoke stays on the project task roles. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.",
"operationId": "updateProjectBedrock",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bedrock": {
"type": "object",
"properties": {
"model_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"use_case": {
"type": "object",
"properties": {
"company_name": {
"type": "string",
"maxLength": 128
},
"company_website": {
"type": "string",
"maxLength": 128
},
"intended_users": {
"type": "string",
"enum": [
"0",
"1",
"2"
]
},
"industry": {
"type": "string",
"maxLength": 128
},
"other_industry": {
"type": "string",
"maxLength": 128
},
"use_cases": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"company_name",
"company_website",
"intended_users",
"industry",
"use_cases"
]
}
},
"required": [
"model_ids"
]
}
},
"required": [
"bedrock"
]
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"use_case_submitted": {
"type": "boolean"
},
"gateway": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"id",
"status"
]
},
{
"type": "null"
}
]
},
"in_progress": {
"type": "boolean"
},
"models": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"type": "string"
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"inference_profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"agreement_required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"availability": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"model_id",
"name",
"provider",
"inference_profile_id",
"agreement_required",
"enabled",
"availability"
]
}
},
"workflow_run_id": {
"type": "string"
}
},
"required": [
"use_case_submitted",
"gateway",
"in_progress",
"models",
"workflow_run_id"
]
}
}
}
},
"409": {
"description": "workflow_in_progress",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "missing_aws_account; missing_permissions; invalid_bedrock; invalid_csrf_token",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"missing_aws_account",
"missing_permissions",
"invalid_bedrock",
"invalid_csrf_token"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found"
]
}
},
"required": [
"error"
]
}
}
}
}
}
}
PATCH /api/projects/{project_id}/bedrock
Save the models this project may call
Checks Bedrock and Marketplace permissions, records the selection, and starts bedrock-sync. Anthropic models need the use case form once per AWS account. Creating an agreement accepts that model’s license. Invoke stays on the project task roles. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.
{
"tags": [
"Bedrock"
],
"summary": "Save the models this project may call",
"operationId": "patchApiProjectsProjectIdBedrock",
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"use_case_submitted": {
"type": "boolean"
},
"gateway": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"id",
"status"
]
},
{
"type": "null"
}
]
},
"in_progress": {
"type": "boolean"
},
"models": {
"type": "array",
"items": {
"type": "object",
"properties": {
"model_id": {
"type": "string"
},
"name": {
"type": "string"
},
"provider": {
"type": "string"
},
"inference_profile_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"agreement_required": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
},
"availability": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"model_id",
"name",
"provider",
"inference_profile_id",
"agreement_required",
"enabled",
"availability"
]
}
},
"workflow_run_id": {
"type": "string"
}
},
"required": [
"use_case_submitted",
"gateway",
"in_progress",
"models",
"workflow_run_id"
]
}
}
}
},
"409": {
"description": "workflow_in_progress",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"workflow_in_progress"
]
}
},
"required": [
"error"
]
}
}
}
},
"422": {
"description": "missing_aws_account; missing_permissions; invalid_bedrock; invalid_csrf_token",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"missing_aws_account",
"missing_permissions",
"invalid_bedrock",
"invalid_csrf_token"
]
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"error"
]
}
}
}
},
"401": {
"description": "unauthenticated",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"unauthenticated"
]
}
},
"required": [
"error"
]
}
}
}
},
"404": {
"description": "project_not_found",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"project_not_found"
]
}
},
"required": [
"error"
]
}
}
}
}
},
"description": "Checks Bedrock and Marketplace permissions, records the selection, and starts bedrock-sync. Anthropic models need the use case form once per AWS account. Creating an agreement accepts that model's license. Invoke stays on the project task roles. For meaningful deployment decisions, read relevant agent notes first. After approval, use createAgentNote to record intent and link returned resource/workflow IDs; append observed outcomes or failures. Notes never authorize changes and must not contain secrets.",
"parameters": [
{
"$ref": "#/components/parameters/ProjectIdInPath"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"bedrock": {
"type": "object",
"properties": {
"model_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"use_case": {
"type": "object",
"properties": {
"company_name": {
"type": "string",
"maxLength": 128
},
"company_website": {
"type": "string",
"maxLength": 128
},
"intended_users": {
"type": "string",
"enum": [
"0",
"1",
"2"
]
},
"industry": {
"type": "string",
"maxLength": 128
},
"other_industry": {
"type": "string",
"maxLength": 128
},
"use_cases": {
"type": "string",
"maxLength": 8192
}
},
"required": [
"company_name",
"company_website",
"intended_users",
"industry",
"use_cases"
]
}
},
"required": [
"model_ids"
]
}
},
"required": [
"bedrock"
]
}
}
}
}
}
Referenced definitions
These keys resolve the local references in the operations above.{
"#/components/parameters/ProjectIdInPath": {
"name": "project_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
}