# Discover the available factory surface

Discover the available factory surface

`GET /api/capabilities`

## Example request

```bash
curl --request GET \
  --url https://api.hoplite.sh/api/capabilities \
  --header "X-Api-Key: $HOPLITE_API_KEY"
```

## 200 response

Successful response

Content type: `application/json`. Response type: `object`.

| Field | Type | Required | Constraints | Description |
| --- | --- | --- | --- | --- |
| `ok` | `boolean` | Yes | constant true | — |
| `principalId` | `string` | Yes | — | — |
| `orgId` | `string` | Yes | — | — |
| `projectIds` | `string[] \| null` | Yes | — | — |
| `projectIds.Option 1` | `string[]` | No | — | — |
| `projectIds.Option 1.[item]` | `string` | No | — | — |
| `projectIds.Option 2` | `null` | No | — | — |
| `permissions` | `object \| null` | Yes | — | — |
| `permissions.Option 1` | `object` | No | — | — |
| `permissions.Option 1.[key]` | `string[]` | No | — | — |
| `permissions.Option 1.[key].[item]` | `string` | No | — | — |
| `permissions.Option 2` | `null` | No | — | — |
| `operations` | `object[]` | Yes | — | — |
| `operations.operationId` | `string` | Yes | — | — |
| `operations.method` | `string` | Yes | — | — |
| `operations.path` | `string` | Yes | — | — |
| `operations.permission` | `string` | No | — | — |
| `operations.permissions` | `string[]` | Yes | — | — |
| `operations.permissions.[item]` | `string` | No | — | — |
| `availability` | `object` | Yes | — | — |
| `availability.[key]` | `boolean` | No | — | — |
| `limits` | `object` | Yes | — | — |
| `limits.eventRetentionDays` | `number` | Yes | constant 7 | — |
| `limits.idempotencyRetentionDays` | `number` | Yes | constant 7 | Settled receipts and their retry keys are retained for at least this many days. Unsettled keys are kept for 30 days unless a retry reconciles them first. |
| `limits.credentialLifetimeDays` | `number` | Yes | constant 90 | — |
| `limits.credentialOverlapHours` | `number` | Yes | constant 24 | — |
| `limits.attachmentMaxBytes` | `number` | Yes | — | — |

```json

```

## Response headers

| Header | Type | Statuses | Description |

| --- | --- | --- | --- |

| `RateLimit` | `string` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Current ingress policy, remaining requests, and seconds until reset, for example `"ingress";r=599;t=60`. |

| `RateLimit-Policy` | `string` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Ingress quota and window, for example `"ingress";q=600;qu="requests";w=60`. |

| `X-RateLimit-Limit` | `integer` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Maximum requests allowed in the current rolling window. |

| `X-RateLimit-Remaining` | `integer` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Requests remaining in the current rolling window. |

| `X-RateLimit-Reset` | `integer` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Unix timestamp when the current rolling window resets. |

| `x-request-id` | `string` | `200`, `400`, `401`, `402`, `403`, `404`, `409`, `410`, `429`, `500`, `501`, `503` | Request correlation ID. |

| `Retry-After` | `integer` | `429`, `503` | Seconds until another request should be attempted. |

| `X-Retry-After` | `integer` | `429`, `503` | Legacy retry delay in seconds. |

## Status codes

- `200` — Successful response

- `400` — Invalid request. Validation responses include field paths.

- `401` — The API key is missing, invalid, or lacks the operation's permission.

- `402` — The organization does not have access to the requested product capability.

- `403` — The key's current user no longer has the required organization membership or role.

- `404` — The resource is not available in the authenticated scope.

- `409` — The request conflicts with a retry receipt or current resource state.

- `410` — The event cursor has expired; capture a fresh head and resource snapshot.

- `429` — The API-key rate limit has been exceeded.

- `500` — The API encountered an unexpected failure.

- `501` — The deployment has not configured the requested capability.

- `503` — A required API dependency, including the rate limiter, is unavailable.