# Get capabilities

> operationId: `getCapabilities`


## Request

Gets the RPA capabilities. The operations array lists only the operationIds that are actually registered and authorized right now. Record catalogRevision. Later write requests that compile a workflow must send it. A capabilities snapshot is not a permanent authorization. Saving, validation, and starting a run check again.

- **Prerequisites**: The desktop client has the RPA Local API enabled, and the credentials are valid.
- **Authentication**: Same as the rest of the Local API; see [Authentication](/api-reference/getting-started/authentication). Resources belong to the current account/team data scope.
- **Side effects**: None. This call doesn't write business data or start a browser.
- **Completion signal**: 200 means you received the snapshot of capabilities available to the currently logged-in client.
- **Retries**: Read-only calls can be retried. On 429 or 503, back off as indicated by Retry-After.


### Endpoint

```http
GET /api/rpa/browser/v1/capabilities
```

Local API: `http://127.0.0.1:<port>/api/rpa/browser/v1/capabilities`. Use the port configured in the client.

### Headers

| Parameter | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `Authorization` | string | When Local API authentication is enabled | See [Authentication](/api-reference/getting-started/authentication). |


### Path parameters

None.

### Query parameters

None.

### Request body

No request body.

### Request example

This is a documentation example; it was not sent to a live client. Set `RPA_BASE_URL` as described in [API conventions](/browser-rpa/api/common). Resource variables, the catalog revision, and ETags come from actual responses.

```bash
curl -i -X GET "${RPA_BASE_URL}/capabilities"
```

## Response

### 200

200 means you received the snapshot of capabilities available to the currently logged-in client.

Body: `application/json`. The top-level `data` uses the model below. For `meta`, see [Metadata](/browser-rpa/api/data-types#metadata).

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `apiVersion` | `"v1"` | Yes | Major version of the HTTP API. |
| `schemaVersion` | string | Yes | Version of the authoring contract (semver). |
| `catalogRevision` | string | Yes | Content revision of the node contracts. Format: sha256: followed by 64 hexadecimal digits. |
| `editorVersions` | array<integer> | Yes | List of editor versions that are currently accepted. |
| `parameterVersions` | array<`1`> | Yes | List of parameter versions that can currently be written through the public API. |
| `operations` | array<string> | Yes | Array of operationIds that are registered on this instance and authorized for the current client. |
| `runtimeProfile` | `"v1"` | Yes | External execution policy: the same as runs in the client, with no extra restrictions on nodes, fields, or parameters. |
| `limits` | object | Yes | Live limits. Use the values in the response. |
| `docs` | object | Yes | Same-origin documentation URLs that match the current capabilities. A URL that starts with / resolves against the local origin. |


**`limits` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `limits.requestBytes` | integer | Yes | Maximum size of an HTTP body, in bytes. Minimum 1. |
| `limits.workflowBytes` | integer | Yes | Maximum size of the compactly serialized workflow, in bytes. Minimum 1. |
| `limits.maxNodes` | integer | Yes | Maximum number of nodes per template, including containers. Minimum 1. |
| `limits.maxDepth` | integer | Yes | Maximum nesting depth. Minimum 1. |
| `limits.maxEdits` | integer | Yes | Maximum number of operations in one node edit. Minimum 1. |
| `limits.maxIssues` | integer | Yes | Maximum number of issues returned at once. Minimum 1. |
| `limits.requestsPerMinute` | integer | Yes | Maximum number of requests per minute for the currently logged-in client. Minimum 1. |
| `limits.maxInFlightWrites` | integer | Yes | Maximum number of in-flight writes for the currently logged-in client. Minimum 1. |
| `limits.nodeDataBytes` | integer | Yes | Maximum size of a single data value in a node execution record, in bytes of compact UTF-8 JSON. Default 65536. A value over the limit is omitted as a whole. Minimum 1. |
| `limits.nodePageBytes` | integer | Yes | Maximum size of one complete page of node execution records, in bytes of compact UTF-8 JSON. Default 8388608. A page over the limit returns 413. This is not the request body limit. Minimum 1. |


**`docs` fields**

| Field | Type | Required | Description and constraints |
|  --- | --- | --- | --- |
| `docs.openapi` | string | Yes | URL of the machine-readable document for the local HTTP API. |
| `docs.schema` | string | Yes | URL of the workflow.schema.json document that matches the catalog revision. |
| `docs.aiGuide` | string | Yes | URL of the AI operating guide. |
| `docs.nodeIndex` | string | Yes | URL of the node catalog. |
| `docs.examples` | string | Yes | URL of the complete example document. |


### Response example

All IDs, timestamps, hashes, and run results are sample data. They don't indicate that the sample was executed.

```json
{
  "data": {
    "apiVersion": "v1",
    "schemaVersion": "1.0.0",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "editorVersions": [
      2
    ],
    "parameterVersions": [
      1
    ],
    "operations": [
      "getCapabilities",
      "listNodeTypes",
      "getNodeType",
      "validateWorkflow",
      "listTemplates",
      "createTemplate",
      "getTemplate",
      "replaceTemplate",
      "deleteTemplate",
      "copyTemplate",
      "listTemplateNodes",
      "editTemplateNodes",
      "startRun",
      "listRuns",
      "getRun",
      "cancelRun",
      "listRunNodes",
      "listRunArtifacts",
      "getRequestReceipt"
    ],
    "runtimeProfile": "v1",
    "limits": {
      "requestBytes": 5242880,
      "workflowBytes": 4194304,
      "maxNodes": 1000,
      "maxDepth": 32,
      "maxEdits": 100,
      "maxIssues": 200,
      "requestsPerMinute": 60,
      "maxInFlightWrites": 4,
      "nodeDataBytes": 65536,
      "nodePageBytes": 8388608
    },
    "docs": {
      "openapi": "/api/rpa/browser/v1/openapi.json",
      "schema": "/api/rpa/browser/v1/docs/api/workflow.schema.json",
      "aiGuide": "/api/rpa/browser/v1/docs/SKILL.md",
      "nodeIndex": "/api/rpa/browser/v1/docs/api/node-contracts.md",
      "examples": "/api/rpa/browser/v1/docs/api/complete-example.md"
    }
  },
  "meta": {
    "requestId": "7d498f20-7bab-4e59-9b05-88daf51230e9",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}
```

### Error responses

For common 400/401/403/404/429/5xx errors and failure fields, see [Errors and recovery](/browser-rpa/api/common#errors-and-recovery). Error response example (403):

```json
{
  "error": {
    "code": "RPA_PERMISSION_DENIED",
    "message": "The request Host or Origin is not allowed, or the current identity can't access the target environment",
    "retryable": false,
    "issues": [],
    "details": null
  },
  "meta": {
    "requestId": "7d498f20-7bab-4e59-9b05-88daf51230e9",
    "catalogRevision": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  }
}
```

## Related

[Local API reference](/browser-rpa/local-api) · [API conventions](/browser-rpa/api/common) · [Data models](/browser-rpa/api/data-types) · [Workflow structure](/browser-rpa/api/workflow) · [Quickstart](/browser-rpa/quickstart)