# Get the OpenAPI document for the organization API

Public, rate limited by the discovery limiter.

> **Note:**

**Not fully described yet.** The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

`GET /api/v1/openapi/org-api.json`

- 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 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted); up to 120 requests a minute per IP address.

Public, rate limited by the discovery limiter. Answers the organization API's document with `servers[0].url` set to this install's URL, cacheable for five minutes, with a weak ETag. Answers 503 when the document is not available on the server.

## Request

This operation takes no parameters and no body.

## Example request

Replace each `YOUR_...` value with your own.

```bash title="cURL"
curl -X GET "https://api.console.buildbase.app/api/v1/openapi/org-api.json"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/openapi/org-api.json',
  {
    method: 'GET',
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
```

```python title="Python"
import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/openapi/org-api.json",
    timeout=30,
)
response.raise_for_status()
data = response.text
```

## Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

### Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

## 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.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Discovery guide](/agents/agent-ready): how this part of BuildBase works
- [All Discovery operations](/http-api/reference/discovery)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `discovery.openapi.org.get` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
