> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orcapods.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK Method Map

> Cross-language map of generated TypeScript, Python, and Go SDK resource methods.

This page maps the generated resource clients across all SDK languages. Use it when translating an example from one language to another.

<Note>
  The resource coverage is generated from `docs/openapi.sdk.yaml`, which is filtered from the canonical `docs/openapi.yaml`. Operator-only, webhook, maintenance, and service-callback operations are intentionally absent from the SDKs.
</Note>

***

## Resource clients

| Resource       | TypeScript             | Python                  | Go                     |
| -------------- | ---------------------- | ----------------------- | ---------------------- |
| Misc           | `client.misc`          | `client.misc`           | `client.Misc`          |
| Profiles       | `client.profiles`      | `client.profiles`       | `client.Profiles`      |
| Pools          | `client.pools`         | `client.pools`          | `client.Pools`         |
| Sessions       | `client.sessions`      | `client.sessions`       | `client.Sessions`      |
| Runs           | `client.runs`          | `client.runs`           | `client.Runs`          |
| Workflows      | `client.workflows`     | `client.workflows`      | `client.Workflows`     |
| Skills         | `client.skills`        | `client.skills`         | `client.Skills`        |
| MCP            | `client.mcp`           | `client.mcp`            | `client.Mcp`           |
| Storage        | `client.storage`       | `client.storage`        | `client.Storage`       |
| Memory         | `client.memory`        | `client.memory`         | `client.Memory`        |
| Secrets        | `client.secrets`       | `client.secrets`        | `client.Secrets`       |
| API Keys       | `client.apiKeys`       | `client.api_keys`       | `client.APIKeys`       |
| Publishing     | `client.publishing`    | `client.publishing`     | `client.Publishing`    |
| Billing        | `client.billing`       | `client.billing`        | `client.Billing`       |
| Connected Apps | `client.connectedApps` | `client.connected_apps` | `client.ConnectedApps` |
| Topology       | `client.topology`      | `client.topology`       | `client.Topology`      |
| Stats          | `client.stats`         | `client.stats`          | `client.Stats`         |

***

## Misc

| Operation                | TypeScript                | Python                      | Go                           |
| ------------------------ | ------------------------- | --------------------------- | ---------------------------- |
| Health check             | `health()`                | `health()`                  | `Health(ctx)`                |
| Seed Orca helper profile | `seedOrca()`              | `seed_orca()`               | `SeedOrca(ctx)`              |
| List capability bundles  | `listCapabilityBundles()` | `list_capability_bundles()` | `ListCapabilityBundles(ctx)` |

***

## Profiles

| Operation            | TypeScript                     | Python                      | Go                          |
| -------------------- | ------------------------------ | --------------------------- | --------------------------- |
| List profiles        | `list()`                       | `list()`                    | `List(ctx)`                 |
| Get profile          | `get({ name })`                | `get(name)`                 | `Get(ctx, request)`         |
| Create profile       | `create(profile)`              | `create(...)`               | `Create(ctx, profile)`      |
| Update profile       | `update({ name, body })`       | `update(name_, ...)`        | `Update(ctx, request)`      |
| Delete profile       | `delete({ name })`             | `delete(name)`              | `Delete(ctx, request)`      |
| List profile changes | `listChanges({ name })`        | `list_changes(name)`        | `ListChanges(ctx, request)` |
| List profile runs    | `listRuns({ name })`           | `list_runs(name)`           | `ListRuns(ctx, request)`    |
| Attach skill         | `attachSkill({ name, skill })` | `attach_skill(name, skill)` | `AttachSkill(ctx, request)` |
| Detach skill         | `detachSkill({ name, skill })` | `detach_skill(name, skill)` | `DetachSkill(ctx, request)` |

***

## Pools

| Operation     | TypeScript                        | Python                         | Go                           |
| ------------- | --------------------------------- | ------------------------------ | ---------------------------- |
| List pools    | `list()`                          | `list()`                       | `List(ctx)`                  |
| Create pool   | `create(pool)`                    | `create(...)`                  | `Create(ctx, pool)`          |
| Delete pool   | `delete({ name })`                | `delete(name)`                 | `Delete(ctx, request)`       |
| Update pool   | `update({ name, body })`          | `update(name_, ...)`           | `Update(ctx, request)`       |
| Add member    | `addMember({ name, profile })`    | `add_member(name, profile)`    | `AddMember(ctx, request)`    |
| Remove member | `removeMember({ name, profile })` | `remove_member(name, profile)` | `RemoveMember(ctx, request)` |

***

## Sessions

| Operation         | TypeScript         | Python          | Go                       |
| ----------------- | ------------------ | --------------- | ------------------------ |
| List sessions     | `list()`           | `list()`        | `List(ctx)`              |
| Retrieve session  | `retrieve({ id })` | `retrieve(id)`  | `Retrieve(ctx, request)` |
| Delete session    | `delete({ id })`   | `delete(id)`    | `Delete(ctx, request)`   |
| List session runs | `listRuns({ id })` | `list_runs(id)` | `ListRuns(ctx, request)` |

***

## Runs

| Operation     | TypeScript             | Python              | Go                           |
| ------------- | ---------------------- | ------------------- | ---------------------------- |
| List runs     | `list()`               | `list()`            | `List(ctx)`                  |
| Create run    | `create(run)`          | `create(...)`       | `Create(ctx, subTask)`       |
| Retrieve run  | `retrieve({ id })`     | `retrieve(id)`      | `Retrieve(ctx, request)`     |
| Cancel run    | `cancel({ id })`       | `cancel(id)`        | `Cancel(ctx, request)`       |
| Replay events | `replayEvents({ id })` | `replay_events(id)` | `ReplayEvents(ctx, request)` |
| Stream events | `stream({ id })`       | `stream(id)`        | `Stream(ctx, request)`       |

***

## Workflows

| Operation                    | TypeScript                                                         | Python                                                         | Go                                                           |
| ---------------------------- | ------------------------------------------------------------------ | -------------------------------------------------------------- | ------------------------------------------------------------ |
| Create workflow run          | `createWorkflowRun(run)`                                           | `create_workflow_run(...)`                                     | `CreateWorkflowRun(ctx, request)`                            |
| List workflow runs           | `listWorkflowRuns(request)`                                        | `list_workflow_runs(...)`                                      | `ListWorkflowRuns(ctx, request)`                             |
| Retrieve workflow run        | `retrieveWorkflowRun({ id })`                                      | `retrieve_workflow_run(id)`                                    | `RetrieveWorkflowRun(ctx, request)`                          |
| Start workflow run           | `startWorkflowRun({ id })`                                         | `start_workflow_run(id)`                                       | `StartWorkflowRun(ctx, request)`                             |
| Cancel workflow run          | `cancelWorkflowRun({ id })`                                        | `cancel_workflow_run(id)`                                      | `CancelWorkflowRun(ctx, request)`                            |
| Repair workflow run          | `repairWorkflowRun({ id, type, ... })`                             | `repair_workflow_run(id, type=..., ...)`                       | `RepairWorkflowRun(ctx, request)`                            |
| Stream workflow run          | `streamWorkflowRun({ id })`                                        | `stream_workflow_run(id)`                                      | `StreamWorkflowRun(ctx, request)`                            |
| Create workflow definition   | `createWorkflowDefinition(def)`                                    | `create_workflow_definition(...)`                              | `CreateWorkflowDefinition(ctx, request)`                     |
| List workflow definitions    | `listWorkflowDefinitions()`                                        | `list_workflow_definitions()`                                  | `ListWorkflowDefinitions(ctx)`                               |
| Retrieve workflow definition | `retrieveWorkflowDefinition({ id })`                               | `retrieve_workflow_definition(id)`                             | `RetrieveWorkflowDefinition(ctx, request)`                   |
| Update workflow definition   | `updateWorkflowDefinition({ id, body })`                           | `update_workflow_definition(id, ...)`                          | `UpdateWorkflowDefinition(ctx, request)`                     |
| Delete workflow definition   | `deleteWorkflowDefinition({ id })`                                 | `delete_workflow_definition(id)`                               | `DeleteWorkflowDefinition(ctx, request)`                     |
| Create workflow schedule     | `createWorkflowSchedule(sched)`                                    | `create_workflow_schedule(...)`                                | `CreateWorkflowSchedule(ctx, request)`                       |
| List workflow schedules      | `listWorkflowSchedules()`                                          | `list_workflow_schedules()`                                    | `ListWorkflowSchedules(ctx)`                                 |
| Retrieve workflow schedule   | `retrieveWorkflowSchedule({ id })`                                 | `retrieve_workflow_schedule(id)`                               | `RetrieveWorkflowSchedule(ctx, request)`                     |
| Pause/resume schedule        | `pauseWorkflowSchedule({ id })` / `resumeWorkflowSchedule({ id })` | `pause_workflow_schedule(id)` / `resume_workflow_schedule(id)` | `PauseWorkflowSchedule(...)` / `ResumeWorkflowSchedule(...)` |
| Delete workflow schedule     | `deleteWorkflowSchedule({ id })`                                   | `delete_workflow_schedule(id)`                                 | `DeleteWorkflowSchedule(ctx, request)`                       |

***

## Skills

| Operation             | TypeScript                            | Python                           | Go                                     |
| --------------------- | ------------------------------------- | -------------------------------- | -------------------------------------- |
| List skills           | `list()`                              | `list()`                         | `List(ctx)`                            |
| Create skill          | `create(skill)`                       | `create(...)`                    | `Create(ctx, skill)`                   |
| Retrieve skill        | `retrieve({ name })`                  | `retrieve(name)`                 | `Retrieve(ctx, request)`               |
| Update skill          | `update({ name, body })`              | `update(name_, ...)`             | `Update(ctx, request)`                 |
| Delete skill          | `delete({ name })`                    | `delete(name)`                   | `Delete(ctx, request)`                 |
| Get skill resource    | `getResource({ name, path })`         | `get_resource(name, path)`       | `GetResource(ctx, request)`            |
| Put skill resource    | `putResource(uploadable, name, path)` | `put_resource(file, name, path)` | `PutResource(ctx, name, path, reader)` |
| Delete skill resource | `deleteResource({ name, path })`      | `delete_resource(name, path)`    | `DeleteResource(ctx, request)`         |

***

## MCP

| Operation       | TypeScript               | Python               | Go                       |
| --------------- | ------------------------ | -------------------- | ------------------------ |
| List servers    | `list()`                 | `list()`             | `List(ctx)`              |
| Create server   | `create(server)`         | `create(...)`        | `Create(ctx, server)`    |
| Test server     | `test(server)`           | `test(...)`          | `Test(ctx, server)`      |
| Retrieve server | `retrieve({ name })`     | `retrieve(name)`     | `Retrieve(ctx, request)` |
| Update server   | `update({ name, body })` | `update(name_, ...)` | `Update(ctx, request)`   |
| Delete server   | `delete({ name })`       | `delete(name)`       | `Delete(ctx, request)`   |

***

## Storage

| Operation       | TypeScript             | Python           | Go                       |
| --------------- | ---------------------- | ---------------- | ------------------------ |
| Storage info    | `info()`               | `info()`         | `Info(ctx)`              |
| List objects    | `list(request)`        | `list(...)`      | `List(ctx, request)`     |
| Retrieve object | `retrieve({ key })`    | `retrieve(key)`  | `Retrieve(ctx, request)` |
| Put object      | `put(uploadable, key)` | `put(file, key)` | `Put(ctx, key, reader)`  |
| Delete object   | `delete({ key })`      | `delete(key)`    | `Delete(ctx, request)`   |

***

## Memory

| Operation             | TypeScript               | Python               | Go                       |
| --------------------- | ------------------------ | -------------------- | ------------------------ |
| List memories         | `list(request)`          | `list(...)`          | `List(ctx, request)`     |
| Create memory         | `create(request)`        | `create(...)`        | `Create(ctx, request)`   |
| Search memory         | `search(request)`        | `search(...)`        | `Search(ctx, request)`   |
| Retrieve memory       | `retrieve({ name, id })` | `retrieve(name, id)` | `Retrieve(ctx, request)` |
| Delete memory         | `delete({ name, id })`   | `delete(name, id)`   | `Delete(ctx, request)`   |
| Get memory bank       | `getBank()`              | `get_bank()`         | `GetBank(ctx)`           |
| Get memory bank stats | `getBankStats()`         | `get_bank_stats()`   | `GetBankStats(ctx)`      |

***

## Secrets

| Operation     | TypeScript               | Python              | Go                     |
| ------------- | ------------------------ | ------------------- | ---------------------- |
| List secrets  | `list()`                 | `list()`            | `List(ctx)`            |
| Create secret | `create(secret)`         | `create(...)`       | `Create(ctx, secret)`  |
| Update secret | `update({ name, body })` | `update(name, ...)` | `Update(ctx, request)` |
| Delete secret | `delete({ name })`       | `delete(name)`      | `Delete(ctx, request)` |

***

## API Keys

These are tenant-scoped control-plane keys for SDKs, CI, and scripts calling `/api/*`. They are distinct from published-agent keys under the `Publishing` resource.

| Operation      | TypeScript       | Python       | Go                     |
| -------------- | ---------------- | ------------ | ---------------------- |
| List API keys  | `list()`         | `list()`     | `List(ctx)`            |
| Issue API key  | `issue(request)` | `issue(...)` | `Issue(ctx, request)`  |
| Revoke API key | `revoke({ id })` | `revoke(id)` | `Revoke(ctx, request)` |

***

## Publishing

| Operation              | TypeScript                 | Python                 | Go                        |
| ---------------------- | -------------------------- | ---------------------- | ------------------------- |
| List published agents  | `list()`                   | `list()`               | `List(ctx)`               |
| Get published agent    | `get({ name })`            | `get(name)`            | `Get(ctx, request)`       |
| Publish profile        | `publish({ name, body })`  | `publish(name, ...)`   | `Publish(ctx, request)`   |
| Update published agent | `update({ name, body })`   | `update(name, ...)`    | `Update(ctx, request)`    |
| Unpublish profile      | `unpublish({ name })`      | `unpublish(name)`      | `Unpublish(ctx, request)` |
| List agent keys        | `listKeys({ name })`       | `list_keys(name)`      | `ListKeys(ctx, request)`  |
| Issue agent key        | `issueKey({ name, body })` | `issue_key(name, ...)` | `IssueKey(ctx, request)`  |
| Revoke agent key       | `revokeKey({ name, id })`  | `revoke_key(name, id)` | `RevokeKey(ctx, request)` |

***

## Billing

| Operation       | TypeScript          | Python          | Go                       |
| --------------- | ------------------- | --------------- | ------------------------ |
| Retrieve wallet | `wallet()`          | `wallet()`      | `Wallet(ctx)`            |
| Start checkout  | `checkout(request)` | `checkout(...)` | `Checkout(ctx, request)` |

***

## Connected Apps

| Operation           | TypeScript                       | Python                       | Go                                 |
| ------------------- | -------------------------------- | ---------------------------- | ---------------------------------- |
| List providers      | `listProviders()`                | `list_providers()`           | `ListProviders(ctx)`               |
| List apps           | `listApps({ provider })`         | `list_apps(provider)`        | `ListApps(ctx, request)`           |
| Connect app         | `connect({ provider, body })`    | `connect(provider, ...)`     | `Connect(ctx, request)`            |
| List connections    | `listConnections()`              | `list_connections()`         | `ListConnections(ctx)`             |
| Retrieve connection | `retrieveConnection({ id })`     | `retrieve_connection(id)`    | `RetrieveConnection(ctx, request)` |
| Delete connection   | `deleteConnection({ id })`       | `delete_connection(id)`      | `DeleteConnection(ctx, request)`   |
| Repair connection   | `repairConnection({ id, body })` | `repair_connection(id, ...)` | `RepairConnection(ctx, request)`   |

***

## Topology

| Operation         | TypeScript   | Python       | Go              |
| ----------------- | ------------ | ------------ | --------------- |
| Retrieve topology | `retrieve()` | `retrieve()` | `Retrieve(ctx)` |

***

## Stats

| Operation   | TypeScript     | Python         | Go                |
| ----------- | -------------- | -------------- | ----------------- |
| Summary     | `summary()`    | `summary()`    | `Summary(ctx)`    |
| Agents      | `agents()`     | `agents()`     | `Agents(ctx)`     |
| Time series | `timeseries()` | `timeseries()` | `Timeseries(ctx)` |
| Hotspots    | `hotspots()`   | `hotspots()`   | `Hotspots(ctx)`   |

***

## VirtualFS MountInfo

`MountInfo` is the per-mount entry returned by `GET /vfs/mounts` and by `Workspace.mounts()` in all SDK languages.

| Field              | Type   | Description                                                                               |
| ------------------ | ------ | ----------------------------------------------------------------------------------------- |
| `name`             | string | Mount name (e.g. `"root"` for the boot-time system mount, or a user mount name)           |
| `pathPrefix`       | string | Mount path prefix (e.g. `"/"` for the system root mount, or `"/mydata"` for a user mount) |
| `mode`             | string | `"read"` or `"write"`                                                                     |
| `ttlSeconds`       | int    | Cache TTL for this mount                                                                  |
| `status`           | string | `"ready"` or `"unavailable"`                                                              |
| `reason`           | string | Set when `status="unavailable"`; carries the boot-time backend error                      |
| `backend.kind`     | string | `"ram"` or `"r2"`                                                                         |
| `backend.bucket`   | string | R2/S3 bucket name (omitted for `ram`)                                                     |
| `backend.endpoint` | string | S3-compatible endpoint URL (omitted when default AWS S3)                                  |
| `backend.prefix`   | string | Optional key prefix inside the bucket                                                     |

Python uses snake\_case (`path_prefix`, `ttl_seconds`); TypeScript and the wire format use camelCase (`pathPrefix`, `ttlSeconds`). The `backend` sub-object uses the same casing as the parent language.

For per-language `validate()` usage and error types (`MountMismatch`, `MountUnavailable`), see [VirtualFS SDKs](/virtualfs/sdks#strict-mount-validation-python).