Bot Management Endpoints

Overview

Bot management endpoints allow you to create custom bots with specific instructions, knowledge bases, tools, and generation parameters.

Create Bot

Request Body

string

required

Unique bot identifier

title

string

required

Bot display name

instruction

string

required

System instruction for the bot’s behavior

description

string

Bot description shown to users

generation_params

object

Model generation parameters

Show generation_params properties

max_tokens

integer

Maximum tokens to generate

top_k

integer

Top-K sampling parameter

top_p

float

Top-P (nucleus) sampling parameter

temperature

float

Temperature for randomness (0.0-1.0)

stop_sequences

array

Array of strings to stop generation

reasoning_params

object

Reasoning parameters for reasoning-enabled models

Show reasoning_params properties

budget_tokens

integer

Token budget for reasoning

agent

object

Agent configuration with tools

Show agent properties

tools

array

required

Array of tool configurations

Show tool properties

tool_type

string

required

Type of tool: "plain", "internet", or "bedrock_agent"

name

string

required

Tool name

description

string

required

Tool description

search_engine

string

Search engine for internet tools: "duckduckgo" or "firecrawl"

firecrawl_config

object

Configuration for Firecrawl search

Show firecrawl_config properties

api_key

string

required

Firecrawl API key

max_results

integer

default:"10"

Maximum results (1-100)

bedrockAgentConfig

object

Configuration for Bedrock Agent tools

Show bedrockAgentConfig properties

agent_id

string

required

Bedrock Agent ID

alias_id

string

required

Bedrock Agent alias ID

knowledge

object

Knowledge base configuration

Show knowledge properties

source_urls

array

Array of source URLs to crawl

sitemap_urls

array

Array of sitemap URLs

filenames

array

Array of uploaded filenames

s3_urls

array

Array of S3 URLs (must end with /)

display_retrieved_chunks

boolean

required

Whether to show retrieved chunks to users

prompt_caching_enabled

boolean

default:"true"

Enable prompt caching for faster responses

conversation_quick_starters

array

Array of conversation starter suggestions

Show quick starter properties

title

string

required

Quick starter title

example

string

required

Example message text

bedrock_knowledge_base

object

Bedrock Knowledge Base configuration

bedrock_guardrails

object

Bedrock Guardrails configuration

active_models

object

required

Object specifying which models are active for this bot (model names with underscores as keys, boolean values)

Example Request

{
  "id": "tech-support-bot",
  "title": "Tech Support Assistant",
  "instruction": "You are a helpful technical support assistant. Answer questions clearly and provide step-by-step solutions.",
  "description": "AI assistant for technical support queries",
  "generation_params": {
    "max_tokens": 2000,
    "top_k": 250,
    "top_p": 0.9,
    "temperature": 0.7,
    "stop_sequences": [],
    "reasoning_params": {
      "budget_tokens": 1000
    }
  },
  "agent": {
    "tools": [
      {
        "tool_type": "internet",
        "name": "web_search",
        "description": "Search the web for current information",
        "search_engine": "duckduckgo"
      }
    ]
  },
  "knowledge": {
    "source_urls": ["https://docs.example.com"],
    "sitemap_urls": [],
    "filenames": [],
    "s3_urls": []
  },
  "display_retrieved_chunks": true,
  "prompt_caching_enabled": true,
  "conversation_quick_starters": [
    {
      "title": "Common Issues",
      "example": "What are the most common technical issues?"
    }
  ],
  "bedrock_knowledge_base": null,
  "bedrock_guardrails": null,
  "active_models": {
    "claude_v3_5_sonnet": true,
    "claude_v4_opus": true
  }
}

Update Bot

Path Parameters

bot_id

string

required

The bot ID to update

Request Body

Same structure as create bot, except:

knowledge

object

Knowledge diff for updates

Show knowledge properties

source_urls

array

New array of source URLs

sitemap_urls

array

New array of sitemap URLs

s3_urls

array

New array of S3 URLs

added_filenames

array

Filenames to add

deleted_filenames

array

Filenames to remove

unchanged_filenames

array

Filenames to keep

Get All Bots

Query Parameters

kind

string

default:"private"

Filter by bot kind: "private" or "mixed"

starred

boolean

default:"false"

Filter to only starred bots

limit

integer

Limit number of results

Response

Returns an array of bot metadata:

string

Bot identifier

title

string

Bot title

description

string

Bot description

create_time

float

Unix timestamp of creation

last_used_time

float

Unix timestamp of last use

is_starred

boolean

Whether the bot is starred

owned

boolean

Whether the current user owns the bot

available

boolean

Whether the bot is available (can be false if original bot is removed)

sync_status

string

Knowledge base sync status: "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", etc.

shared_scope

string

Sharing scope: "private", "partial", or "all"

shared_status

string

Shared status: "private", "shared", or "pinned@xxx"

Get Pinned Bots

Get Private Bot

Path Parameters

bot_id

string

required

The bot ID to retrieve

Response

Returns complete bot configuration including all settings, knowledge base, agent tools, generation parameters, and sync status.

Get Bot Summary

Path Parameters

bot_id

string

required

The bot ID

Response

string

Bot identifier

title

string

Bot title

description

string

Bot description

has_agent

boolean

Whether the bot has agent tools configured

has_knowledge

boolean

Whether the bot has a knowledge base

conversation_quick_starters

array

Array of quick starter suggestions

active_models

object

Active models for this bot

Delete Bot

Path Parameters

bot_id

string

required

The bot ID to delete

Update Bot Star Status

Path Parameters

bot_id

string

required

The bot ID

Request Body

starred

boolean

required

True to star, false to unstar

Update Bot Visibility

Path Parameters

bot_id

string

required

The bot ID

Request Body

One of three visibility types: Private:

target_shared_scope

string

required

Must be "private"

Partial (specific users/groups):

target_shared_scope

string

required

Must be "partial"

target_allowed_user_ids

array

required

Array of user IDs to share with

target_allowed_group_ids

array

required

Array of group IDs to share with

All (public):

target_shared_scope

string

required

Must be "all"

Get Presigned URL for Upload

Path Parameters

bot_id

string

required

The bot ID

Query Parameters

filename

string

required

Name of the file to upload

contentType

string

required

MIME type of the file

Response

url

string

Presigned S3 URL for upload

Delete Uploaded File

Path Parameters

bot_id

string

required

The bot ID

Query Parameters

filename

string

required

Name of the file to delete

Remove from Recently Used

Path Parameters

bot_id

string

required

The bot ID

Get Available Tools

Path Parameters

bot_id

string

required

The bot ID

Response

Returns an array of available tool configurations with their types, names, and descriptions.

REST API

CDK API

​Overview

​Create Bot

​Request Body

​Example Request

​Update Bot

​Path Parameters

​Request Body

​Get All Bots

​Query Parameters

​Response

​Get Pinned Bots

​Get Private Bot

​Path Parameters

​Response

​Get Bot Summary

​Path Parameters

​Response

​Delete Bot

​Path Parameters

​Update Bot Star Status

​Path Parameters

​Request Body

​Update Bot Visibility

​Path Parameters

​Request Body

​Get Presigned URL for Upload

​Path Parameters

​Query Parameters

​Response

​Delete Uploaded File

​Path Parameters

​Query Parameters

​Remove from Recently Used

​Path Parameters

​Get Available Tools

​Path Parameters

​Response

Build docs developers (and LLMs) love

Overview

Create Bot

Request Body

Example Request

Update Bot

Path Parameters

Request Body

Get All Bots

Query Parameters

Response

Get Pinned Bots

Get Private Bot

Path Parameters

Response

Get Bot Summary

Path Parameters

Response

Delete Bot

Path Parameters

Update Bot Star Status

Path Parameters

Request Body

Update Bot Visibility

Path Parameters

Request Body

Get Presigned URL for Upload

Path Parameters

Query Parameters

Response

Delete Uploaded File

Path Parameters

Query Parameters

Remove from Recently Used

Path Parameters

Get Available Tools

Path Parameters

Response