Amazon Web Services, Inc.

Agents for Amazon Bedrock

Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore…

AI & machine learning#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore Amazon Bedrock AgentCore. Existing customers can continue to use the service as normal. For more information, see Amazon Bedrock Agents Classic availability change . Describes the API operations for creating and managing Amazon Bedrock agents.

Endpoints 86

Agent collaborator

  • PUTAssociate agent collaborator/agents/:agentId/agentversions/:agentVersion/agentcollaborators/Makes an agent a collaborator for another agent.
  • POSTList agent collaborators/agents/:agentId/agentversions/:agentVersion/agentcollaborators/Retrieve a list of an agent's collaborators.
  • GETGet agent collaborator/agents/:agentId/agentversions/:agentVersion/agentcollaborators/:collaboratorId/Retrieves information about an agent's collaborator.
  • PUTUpdate agent collaborator/agents/:agentId/agentversions/:agentVersion/agentcollaborators/:collaboratorId/Updates an agent's collaborator.
  • DELETEDisassociate agent collaborator/agents/:agentId/agentversions/:agentVersion/agentcollaborators/:collaboratorId/Disassociates an agent collaborator.

Knowledge base

  • PUTAssociate agent knowledge base/agents/:agentId/agentversions/:agentVersion/knowledgebases/Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled , the agent queries the knowledge base for…
  • POSTList agent knowledge bases/agents/:agentId/agentversions/:agentVersion/knowledgebases/Lists knowledge bases associated with an agent and information about each one.
  • PUTCreate knowledge base/knowledgebases/Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. To create a knowledge base, you…
  • POSTList knowledge bases/knowledgebases/Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.
  • GETGet knowledge base/knowledgebases/:knowledgeBaseIdGets information about a knowledge base.
  • PUTUpdate knowledge base/knowledgebases/:knowledgeBaseIdUpdates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for…
  • DELETEDelete knowledge base/knowledgebases/:knowledgeBaseIdDeletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a…
  • GETGet agent knowledge base/agents/:agentId/agentversions/:agentVersion/knowledgebases/:knowledgeBaseId/Gets information about a knowledge base associated with an agent.
  • PUTUpdate agent knowledge base/agents/:agentId/agentversions/:agentVersion/knowledgebases/:knowledgeBaseId/Updates the configuration for a knowledge base that has been associated with an agent.
  • DELETEDisassociate agent knowledge base/agents/:agentId/agentversions/:agentVersion/knowledgebases/:knowledgeBaseId/Disassociates a knowledge base from an agent.

Agent

  • PUTCreate agent/agents/Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore…
  • POSTList agents/agents/Lists the agents belonging to an account and information about each agent.
  • GETGet agent/agents/:agentId/Gets information about an agent.
  • PUTUpdate agent/agents/:agentId/Updates the configuration of an agent.
  • POSTPrepare agent/agents/:agentId/Creates a DRAFT version of the agent that can be used for internal testing.
  • DELETEDelete agent/agents/:agentId/?skipResourceInUseCheck=trueDeletes an agent.

Action group

  • PUTCreate agent action group/agents/:agentId/agentversions/:agentVersion/actiongroups/Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent…
  • POSTList agent action groups/agents/:agentId/agentversions/:agentVersion/actiongroups/Lists the action groups for an agent and information about each one.
  • GETGet agent action group/agents/:agentId/agentversions/:agentVersion/actiongroups/:actionGroupId/Gets information about an action group for an agent.
  • PUTUpdate agent action group/agents/:agentId/agentversions/:agentVersion/actiongroups/:actionGroupId/Updates the configuration for an action group for an agent.
  • DELETEDelete agent action group/agents/:agentId/agentversions/:agentVersion/actiongroups/:actionGroupId/?skipResourceInUseCheck=trueDeletes an action group in an agent.

Alias

  • PUTCreate agent alias/agents/:agentId/agentaliases/Creates an alias of an agent that can be used to deploy the agent.
  • POSTList agent aliases/agents/:agentId/agentaliases/Lists the aliases of an agent and information about each one.
  • GETGet agent alias/agents/:agentId/agentaliases/:agentAliasId/Gets information about an alias of an agent.
  • PUTUpdate agent alias/agents/:agentId/agentaliases/:agentAliasId/Updates configurations for an alias of an agent.
  • DELETEDelete agent alias/agents/:agentId/agentaliases/:agentAliasId/Deletes an alias of an agent.

Data source

  • PUTCreate data source/knowledgebases/:knowledgeBaseId/datasources/Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the dataSourceConfiguration field. You can't…
  • POSTList data sources/knowledgebases/:knowledgeBaseId/datasources/Lists the data sources in a knowledge base and information about each one.
  • GETGet data source/knowledgebases/:knowledgeBaseId/datasources/:dataSourceIdGets information about a data source.
  • PUTUpdate data source/knowledgebases/:knowledgeBaseId/datasources/:dataSourceIdUpdates the configurations for a data source connector. You can't change the chunkingConfiguration after you create the data source connector. Specify the…
  • DELETEDelete data source/knowledgebases/:knowledgeBaseId/datasources/:dataSourceIdDeletes a data source from a knowledge base.

Flow

  • GETList flows/flows/?maxResults=0&nextToken=stringReturns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
  • POSTCreate flow/flows/Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the…
  • GETGet flow/flows/:flowIdentifier/?includedData=stringRetrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
  • PUTUpdate flow/flows/:flowIdentifier/Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in…
  • POSTPrepare flow/flows/:flowIdentifier/Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
  • DELETEDelete flow/flows/:flowIdentifier/?skipResourceInUseCheck=trueDeletes a flow.

Flow alias

  • GETList flow aliases/flows/:flowIdentifier/aliases?maxResults=0&nextToken=stringReturns a list of aliases for a flow.
  • POSTCreate flow alias/flows/:flowIdentifier/aliasesCreates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
  • GETGet flow alias/flows/:flowIdentifier/aliases/:aliasIdentifierRetrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
  • PUTUpdate flow alias/flows/:flowIdentifier/aliases/:aliasIdentifierModifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon…
  • DELETEDelete flow alias/flows/:flowIdentifier/aliases/:aliasIdentifierDeletes an alias of a flow.

Flow version

  • GETList flow versions/flows/:flowIdentifier/versions?maxResults=0&nextToken=stringReturns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
  • POSTCreate flow version/flows/:flowIdentifier/versionsCreates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
  • GETGet flow version/flows/:flowIdentifier/versions/:flowVersion/?includedData=stringRetrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
  • DELETEDelete flow version/flows/:flowIdentifier/versions/:flowVersion/?skipResourceInUseCheck=trueDeletes a version of a flow.

Prompt

  • GETList prompts/prompts/?promptIdentifier=string&maxResults=0&nextToken=stringReturns either information about the working draft ( DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending…
  • POSTCreate prompt/prompts/Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock , Create a prompt using…
  • POSTCreate prompt version/prompts/:promptIdentifier/versionsCreates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating…
  • GETGet prompt/prompts/:promptIdentifier/?promptVersion=string&includedData=stringRetrieves information about the working draft ( DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or…
  • PUTUpdate prompt/prompts/:promptIdentifier/Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt…
  • DELETEDelete prompt/prompts/:promptIdentifier/?promptVersion=stringDeletes a prompt or a version of it, depending on whether you include the promptVersion field or not. For more information, see Delete prompts from the Prompt…

Retrieval instruction

  • GETList retrieval instructions/retrievalinstructions/?status=string&maxResults=0&nextToken=stringLists the retrieval instructions in the caller's account. Results are paginated. Use the nextToken parameter to retrieve additional results.
  • POSTCreate retrieval instruction/retrievalinstructions/Creates a new retrieval instruction. The retrieval instruction is usable once its status becomes ACTIVE. Use GetRetrievalInstruction to check whether it is…
  • GETList retrieval instruction versions/retrievalinstructions/:retrievalInstructionId/versions?maxResults=0&nextToken=stringLists the numbered versions of a retrieval instruction, newest first. DRAFT is not listed; read it with GetRetrievalInstruction without…
  • POSTCreate retrieval instruction version/retrievalinstructions/:retrievalInstructionId/versionsCreates an immutable numbered version from the retrieval instruction's current reviewed content. The service creates the version synchronously. The service…
  • GETGet retrieval instruction/retrievalinstructions/:retrievalInstructionId?retrievalInstructionVersion=stringGets a retrieval instruction. Also used to poll the terminal reporting of an asynchronous create or update.
  • PUTUpdate retrieval instruction/retrievalinstructions/:retrievalInstructionIdUpdates the content of a retrieval instruction. The update is processed asynchronously; the stored content is a candidate until content review passes, and the…
  • DELETEDelete retrieval instruction/retrievalinstructions/:retrievalInstructionId?retrievalInstructionVersion=stringDeletes a retrieval instruction or a single version of it. Omit retrievalInstructionVersion to delete the retrieval instruction itself; the service rejects…

Version

  • GETGet agent version/agents/:agentId/agentversions/:agentVersion/Gets details about a version of an agent.
  • DELETEDelete agent version/agents/:agentId/agentversions/:agentVersion/?skipResourceInUseCheck=trueDeletes a version of an agent.
  • POSTList agent versions/agents/:agentId/agentversions/Lists the versions of an agent and information about each version.

Knowledge base document

  • POSTDelete knowledge base documents/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/documents/deleteDocumentsDeletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly…
  • POSTGet knowledge base documents/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/documents/getDocumentsRetrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base…
  • PUTIngest knowledge base documents/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/documentsIngests documents directly into the knowledge base that is connected to the data source. The dataSourceType specified in the content for each document must…
  • POSTList knowledge base documents/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/documentsRetrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a…

Ingestion job

  • GETGet ingestion job/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/ingestionjobs/:ingestionJobIdGets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
  • PUTStart ingestion job/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/ingestionjobs/Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
  • POSTList ingestion jobs/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/ingestionjobs/Lists the data ingestion jobs for a data source. The list also includes information about each job.
  • POSTStop ingestion job/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/ingestionjobs/:ingestionJobId/stopStops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.

Tagging

  • GETList tags for resource/tags/:resourceArnList all the tags for the resource you specify.
  • POSTTag resource/tags/:resourceArnAssociate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Remove tags from a resource.
  • GETList vpc configurations/knowledgebases/:knowledgeBaseId/vpcconfigurations/?status=string&maxResults=0&nextToken=stringReturns a paginated list of the VPC configurations for a knowledge base. You can optionally filter by status. Use the nextToken parameter to retrieve…
  • POSTCreate vpc configuration/knowledgebases/:knowledgeBaseId/vpcconfigurations/Creates a VPC configuration that lets a knowledge base connect to a resource in your private VPC. This operation is asynchronous: it returns a…
  • GETGet resource policy/resourcepolicy/:resourceArnRetrieves the resource policy associated with a knowledge base.
  • PUTPut resource policy/resourcepolicy/:resourceArnAssociates a resource policy with a knowledge base. A resource policy allows other AWS accounts to access the knowledge base. For more information, see…
  • DELETEDelete resource policy/resourcepolicy/:resourceArn?expectedRevisionId=stringRemoves the resource policy associated with a knowledge base. After deletion, other AWS accounts can no longer access the knowledge base using cross-account…
  • GETGet vpc configuration/knowledgebases/:knowledgeBaseId/vpcconfigurations/:vpcConfigurationIdReturns the details and current status of a single VPC configuration. Use this operation to poll for the outcome of an asynchronous create or delete.
  • DELETEDelete vpc configuration/knowledgebases/:knowledgeBaseId/vpcconfigurations/:vpcConfigurationIdDeletes a VPC configuration. This operation is asynchronous: it returns status DELETING . Poll GetVpcConfiguration until it returns a…
  • POSTValidate flow definition/flows/validate-definitionValidates the definition of a flow.

API details

Base URL
https://bedrock-agent.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
86 operations on 39 pathsPOST 25GET 24PUT 21DELETE 16
Main resources
Knowledge base 10Retrieval instruction 7Agent 6Flow 6Prompt 6Action group 5Agent collaborator 5Alias 5Data source 5Flow alias 5
Description format
AWS Smithy model, API version 2023-06-05

How to test the Agents for Amazon Bedrock in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Agents for Amazon Bedrock collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Associate agent collaborator” (PUT /agents/:agentId/agentversions/:agentVersion/agentcollaborators/), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Agents for Amazon Bedrock?

Amazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore… It is listed under AI & machine learning and has 86 endpoints.

Who publishes the Agents for Amazon Bedrock?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Agents for Amazon Bedrock?

Requests go to https://bedrock-agent.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Agents for Amazon Bedrock?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Agents for Amazon Bedrock have?

86 operations on 39 paths (25 POST, 24 GET, 21 PUT, 16 DELETE). The largest groups are Knowledge base, Retrieval instruction, Agent, Flow.

Is forking the Agents for Amazon Bedrock free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.