Skip to content
docs Explore the platform

ANTSAND · GUIDE

Connect an agent

> Production API availability: use /api/v1/help?view=guides and the resource operations catalog before following a recipe. Some localhost capabilities are not deployed yet; an absent operation is unavailable.

Before you connect

Use a key for the intended environment and owner. Keep it in your shell environment or secret manager. Do not paste it into Notes, Docs, screenshots or a generated page.

The examples below use the local API. Set the production origin only when you intend to work on production.

Examplebash
export API_URL="http://localhost/api/v1"
# Set API_KEY privately in your shell.
curl --fail-with-body "$API_URL/me" \
  -H "Authorization: Bearer $API_KEY"

Confirm identity and scopes

The response identifies the credential and its scopes. Check the owner and allowed operations before selecting a board. A read credential should not be used as evidence that a later write or deployment is permitted.

Examplebash
curl --fail-with-body "$API_URL/databoards" \
  -H "Authorization: Bearer $API_KEY"

Select a board from that response. Then read its source and contextual information.

Examplebash
curl --fail-with-body "$API_URL/databoards/$BOARD_ID" \
  -H "Authorization: Bearer $API_KEY"

curl --fail-with-body "$API_URL/databoards/$BOARD_ID/agent-context" \
  -H "Authorization: Bearer $API_KEY"

Describe the task

Give the agent the environment, board, page and section, followed by the intended change. Include what must remain intact and how you will review the result.

Exampletext
Read the selected board and find the homepage introduction.
Change its heading and summary for a product-team audience.
Keep the current links, section template and brand styles.
Show the proposed source patch and call the server patch dry-run before applying it.
Generate the preview and verify desktop and mobile rendering.

If access fails

A 401 response indicates an authentication problem. A denied operation may require a different scope or resource ownership. Check the response and the key's permissions; do not bypass the module or write directly to a generated directory.

One API prefix

API_URL is your trusted service origin followed by /api/v1. Discover guides at GET /api/v1/help?view=guides. API examples use curl for illustration; any HTTP client can send the same requests. No shell, repository or local helper is required.

Continue with Databoard architecture and agent patches.