Skip to content

docs(steering): document Agentic API endpoint routing and mock registry flag #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lzongren wants to merge 1 commit into
base: main
Choose a base branch
from
+38 −0
Open

docs(steering): document Agentic API endpoint routing and mock registry flag #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions aws-transform-agent-toolkit/steering/agent-registration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,29 @@ client = boto3.client(

**NEVER omit the endpoint URL** — without it, the CLI/SDK will attempt to resolve a non-existent endpoint and fail.

## Agentic API Endpoint (Runtime)

The Agentic API (`transformagenticservice`) is used at runtime for operations like InvokeAgent, SendMessage, ListAgentInstances, and subagent discovery. Like the Registry API, it requires an explicit endpoint.

**In managed compute** (Bedrock AgentCore, MDE): The `QT_AGENTIC_API_ENDPOINT` environment variable is automatically injected by the platform.

**For local development**: Set it explicitly:

```bash
export QT_AGENTIC_API_ENDPOINT=https://iad.prod.agenticapi.elastic-gumby.ai.aws.dev
```

| Stage | Region | Endpoint URL |
|-------|--------|-------------|
| prod | us-east-1 | `https://iad.prod.agenticapi.elastic-gumby.ai.aws.dev` |
| prod | eu-central-1 | `https://fra.prod.agenticapi.elastic-gumby.ai.aws.dev` |
| gamma | us-east-1 | `https://iad.gamma.agenticapi.elastic-gumby.ai.aws.dev` |
| gamma | us-west-2 | `https://pdx.gamma.agenticapi.elastic-gumby.ai.aws.dev` |

The SDK's `get_agentic_api_client()` factory reads this variable. Without it, boto3 attempts to resolve a non-existent public endpoint and fails.

**NEVER use raw `boto3.client('transformagenticservice')` without setting `endpoint_url`** — use `get_agentic_api_client()` from the SDK which handles this automatically.

## Registration Flow

1. **Build & containerize** your agent
Expand Down
15 changes: 15 additions & 0 deletions aws-transform-agent-toolkit/steering/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ Before starting, ensure you've completed the onboarding steps:

**If you haven't done this yet**: The AWS Transform Agent Toolkit onboarding walks you through all installation steps. Kiro will guide you through tool validation, SDK installation, and hook setup when you first activate the power.

## Environment Variables

These environment variables configure the SDK at runtime:

| Variable | Required | Description |
|----------|----------|-------------|
| `QT_AGENTIC_API_ENDPOINT` | Yes (local dev) | Agentic API endpoint URL. Auto-injected in managed compute. See [agent-registration.md](./agent-registration.md) for endpoints per stage. |
| `WORKSPACE_ID` | Yes | ATX workspace identifier |
| `JOB_ID` | Yes | Current job identifier |
| `AGENT_INSTANCE_ID` | Yes | Agent instance identifier |
| `AWS_REGION` | Yes | AWS region for Bedrock model inference |
| `ATX_USE_MOCK_REGISTRY` | No | Set to `true` for offline development without platform connectivity |

For full endpoint details, see the [Agent Registration Guide](./agent-registration.md#agentic-api-endpoint-runtime).

## What You Can Build

With AWS Transform, you create two types of agents:
Expand Down
Loading