Amazon Web Services, Inc.

Agents for Amazon Bedrock Runtime

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 . Contains APIs related to model invocation and querying of knowledge bases.

Endpoints 35

Agentic retrieve stream

  • POSTAgentic retrieve stream/agenticRetrieveStreamRetrieves information from one or more knowledge bases using an agentic approach. Agentic retrieval uses a foundation model to intelligently decompose complex…

Check ingested document acl

  • POSTCheck ingested document acl/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/check-ingested-document-aclChecks whether a user has access to a specific document by verifying against the ingested access control list (ACL) in a knowledge base. Use this operation to…

Invocation

  • PUTCreate invocation/sessions/:sessionIdentifier/invocations/Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information…
  • POSTList invocations/sessions/:sessionIdentifier/invocations/?nextToken=string&maxResults=0Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with…

Session

  • PUTCreate session/sessions/Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and…
  • POSTList sessions/sessions/?maxResults=0&nextToken=stringLists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with…
  • GETGet session/sessions/:sessionIdentifier/Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock…
  • PUTUpdate session/sessions/:sessionIdentifier/Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with…
  • DELETEDelete session/sessions/:sessionIdentifier/Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API…
  • PATCHEnd session/sessions/:sessionIdentifierEnds the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the…

Memory

  • GETGet agent memory/agents/:agentId/agentAliases/:agentAliasId/memories?nextToken=string&maxItems=0&memoryType=string&memoryId=stringGets the sessions stored in the memory of the agent.
  • DELETEDelete agent memory/agents/:agentId/agentAliases/:agentAliasId/memories?memoryId=string&sessionId=stringDeletes memory from the specified memory identifier.

Generate query

  • POSTGenerate query/generateQueryGenerates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.

Get document content

  • POSTGet document content/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/documents/:documentId/contentRetrieves the content of an ingested document from a knowledge base, or of an image embedded in the document. Returns a pre-signed URL for downloading the…

Flow execution

  • GETGet execution flow snapshot/flows/:flowIdentifier/aliases/:flowAliasIdentifier/executions/:executionIdentifier/flowsnapshotRetrieves the flow definition snapshot used for a flow execution. The snapshot represents the flow metadata and definition as it existed at the time the…
  • GETGet flow execution/flows/:flowIdentifier/aliases/:flowAliasIdentifier/executions/:executionIdentifierRetrieves details about a specific flow execution, including its status, start and end times, and any errors that occurred during execution.
  • GETList flow execution events/flows/:flowIdentifier/aliases/:flowAliasIdentifier/executions/:executionIdentifier/events?maxResults=0&nextToken=string&eventType=stringLists events that occurred during a flow execution. Events provide detailed information about the execution progress, including node inputs and outputs, flow…
  • GETList flow executions/flows/:flowIdentifier/executions?flowAliasIdentifier=string&maxResults=0&nextToken=stringLists all executions of a flow. Results can be paginated and include summary information about each execution, such as status, start and end times, and the…
  • POSTStart flow execution/flows/:flowIdentifier/aliases/:flowAliasIdentifier/executionsStarts an execution of an Amazon Bedrock flow. Unlike flows that run until completion or time out after five minutes, flow executions let you run flows…
  • POSTStop flow execution/flows/:flowIdentifier/aliases/:flowAliasIdentifier/executions/:executionIdentifier/stopStops an Amazon Bedrock flow's execution. This operation prevents further processing of the flow and changes the execution status to Aborted .

Get ingested document acl

  • POSTGet ingested document acl/knowledgebases/:knowledgeBaseId/datasources/:dataSourceId/get-ingested-document-aclRetrieves the ingested access control list (ACL) for a specific document in a knowledge base. Use this operation to inspect the allow and deny lists that were…

Invocation step

  • POSTGet invocation step/sessions/:sessionIdentifier/invocationSteps/:invocationStepIdRetrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve…
  • PUTPut invocation step/sessions/:sessionIdentifier/invocationSteps/Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each…
  • POSTList invocation steps/sessions/:sessionIdentifier/invocationSteps/?nextToken=string&maxResults=0Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and…

Inference

  • POSTInvoke agent/agents/:agentId/agentAliases/:agentAliasId/sessions/:sessionId/textAmazon Bedrock Agents (now Amazon Bedrock Agents Classic) is no longer open to new customers. For capabilities similar to Bedrock Agents Classic, explore…

Flow

  • POSTInvoke flow/flows/:flowIdentifier/aliases/:flowAliasIdentifierInvokes an alias of a flow to run the inputs that you specify and return the output of each node as a stream. If there's an error, the error is returned. For…

Inline agent

  • POSTInvoke inline agent/agents/:sessionIdInvokes an inline Amazon Bedrock agent using the configurations you provide with the request. Specify the following fields for security purposes. (Optional)…

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.

Optimize prompt

  • POSTOptimize prompt/optimize-promptOptimizes a prompt for the task that you specify. For more information, see Optimize a prompt in the Amazon Bedrock User Guide .

Rerank

  • POSTRerank/rerankReranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model .

Retrieve

  • POSTRetrieve/knowledgebases/:knowledgeBaseId/retrieveQueries a knowledge base and retrieves information from it.

Retrieve and generate

  • POSTRetrieve and generate/retrieveAndGenerateQueries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile . The response…

Retrieve and generate stream

  • POSTRetrieve and generate stream/retrieveAndGenerateStreamQueries a knowledge base and generates responses based on the retrieved results, with output in streaming format. This API cannot be used with managed…

API details

Base URL
https://bedrock-agent-runtime.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
35 operations on 27 pathsPOST 20GET 7PUT 4DELETE 3PATCH 1
Main resources
Flow execution 6Session 6Invocation step 3Tagging 3Invocation 2Memory 2Agentic retrieve stream 1Check ingested document acl 1Flow 1Generate query 1
Description format
AWS Smithy model, API version 2023-07-26

How to test the Agents for Amazon Bedrock Runtime 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 Runtime 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 “Agentic retrieve stream” (POST /agenticRetrieveStream), 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 Runtime?

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 35 endpoints.

Who publishes the Agents for Amazon Bedrock Runtime?

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 Runtime?

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

How do I authenticate with the Agents for Amazon Bedrock Runtime?

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

How many endpoints does the Agents for Amazon Bedrock Runtime have?

35 operations on 27 paths (20 POST, 7 GET, 4 PUT, 3 DELETE, 1 PATCH). The largest groups are Flow execution, Session, Invocation step, Tagging.

Is forking the Agents for Amazon Bedrock Runtime 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.