Get an organization's auth.md instructions for agents
Public.
GET/org/orgId/auth.md
- Sign-in
- None at the router: the operation is public, or checks its own proof (a signature, a token in the body, a signed link).
- Rate limit
- Up to 120 requests a minute per IP address.
Public. Answers a Markdown document that tells an agent how to register by email and get a token for this organization, cacheable for five minutes. Answers 404 not_found for an unknown organization or when the organization has not turned on agent registration with a usable agent client.
Request
Path parameters
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
orgId | string | Yes | - | - |
Example request
Replace each YOUR_... value with your own.
curl -X GET "https://api.console.buildbase.app/org/YOUR_ORG_ID/auth.md"const response = await fetch(
'https://api.console.buildbase.app/org/YOUR_ORG_ID/auth.md',
{
method: 'GET',
}
);
if (!response.ok) {
throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();import requests
response = requests.get(
"https://api.console.buildbase.app/org/YOUR_ORG_ID/auth.md",
timeout=30,
)
response.raise_for_status()
data = response.textResponses
200 OK
OK
"# auth.md: registering an agent for a person who uses this app\n\nYou are an agent. This tells you how to get an access token to act for one person on this app when all you know is their email address. Follow the steps in order.\n\n## 1. Discover\n\nThe authorization server metadata (RFC 8414) is at http://localhost:3000/.well-known/oauth-authorization-server/org/000000000000000000000001. Its `agent_auth` block names the endpoints below, and its `token_endpoint` is where you poll.\n\n## 2. Register\n\n```"Any other status
Any other answer the handler sends itself (its own refusals). Not described yet.
Errors
Each refusal, what it means, and what to do. The request changed nothing.
429 Too Many Requests
What it means: A rate limit in x-rateLimit was reached. retryAfter and the Retry-After header say how many seconds until the window resets.
What to do: Wait the number of seconds in the Retry-After header (also retryAfter in the body), then retry. Slow down repeated calls.
{
"success": false,
"message": "string",
"reason": "rate_limited",
"retryAfter": 1
}Related
- Discovery guide: how this part of BuildBase works
- All Discovery operations
- API reference: every operation, by tag
- Sign-in and credentials for the HTTP API
- How the HTTP API reports errors
- Make your first call
- Error codes: every
codethe API returns - OpenAPI: operation
discovery.authMd.listin public-v1.json