Skip to content

Developer integration

Integrate provider consoles, websites, and automation with OcHub.

Updated View as Markdown

OcHub exposes versioned integration surfaces for provider websites and local automation. Start with Deep Links to generate a link that opens a reviewed, editable import preview in the desktop app.

Available integrations

Integration Use it for
Deep Links Import model providers, direct connections, MCP servers, or skills
ochcli Parse, validate, dry-run, or apply a Deep Link from local automation

Deep Links are configuration transport, not authentication. If a payload contains an API key, protect the complete URL as a secret.

Read an Overview snapshot

ochcli overview reads the environment in which the command runs. For example, run the second command through your existing SSH alias to read a remote node:

ochcli overview --json
ssh devbox ochcli overview --json

Without bounds, the window is the previous 24 hours. --from and --to accept UTC Unix timestamps in seconds, with a positive span of no more than 366 days:

ochcli overview --from 1791763200 --to 1791849600 --json

The result contains generatedAt, window, and the sections gateway, routing, apps, usage, trend, performance, and recentRequests. Each section has data or error. A successful command may contain a failed section, so inspect these fields before interpreting a missing value. Invalid bounds fail the command. Sections are sampled separately, not in one atomic cross-process transaction.

The command does not probe upstreams, import sessions, or write target configuration. performance is a preview of at most 20 provider/source groups; recentRequests contains at most ten retained details. Do not sum the performance preview as a full-source total or treat route configuration as a request trace.

The desktop’s remote protocol uses overview-v1 and requires provider.read, gateway.read, and usage.read. These protocol capabilities do not turn an unrestricted SSH account into a read-only account. See the Overview guide for the meaning of displayed data.

Editing drafts and explicit application

ochcli editor uses the same separate drafts as the desktop connection editor. Saving permits incomplete fields and invalid raw text without replacing a Provider record or writing target configuration. The input is EditorDraftInput, not a target tool’s raw configuration file. This example contains unusable demo credentials; replace them before using a real service:

{
  "provider": {
    "id": "work-api",
    "name": "Work API",
    "settingsConfig": {
      "env": {
        "ANTHROPIC_BASE_URL": "https://api.example.test",
        "ANTHROPIC_AUTH_TOKEN": "REPLACE_ME"
      }
    }
  },
  "originalProviderId": null,
  "baseProviderHash": null,
  "editorState": {},
  "rawDocuments": null,
  "commonConfig": null
}

Save it as draft-input.json, then create a draft:

ochcli editor save work-draft --app claude --from draft-input.json --json
ochcli editor list --app claude --json
ochcli editor get work-draft --app claude --json
Command Purpose
editor save ID --app APP --from FILE Create a separate draft; omit expected revision only on creation
editor save ID --app APP --from FILE --expected-revision N Update only if its current revision is still N
editor apply ID --app APP --revision N --on-drift abort Validate and apply that revision without replacing newer edits
editor delete ID --app APP --revision N Delete that draft revision, not a connection record
editor undo RECEIPT_ID Undo only when a complete receipt and matching post-write state allow it

Use the returned revision; do not guess or hard-code it. --on-drift accepts abort (default), save, or revert: stop on external changes, preserve the live version, or explicitly revert it. This policy does not bypass draft-revision or Provider-baseline conflicts. Failed application returns a nonzero exit status and structured details for the failed stage, recovery requirements, and any receipt. The draft is retained. externalConfirmation requires confirmation in the external app and is not proof of successful application.

editorState stores unfinished form input; rawDocuments stores native text in codec file order. When raw documents exist, application reparses them instead of using an older parsed provider. When editing an existing connection, preserve the draft’s originalProviderId and baseProviderHash. Never overwrite a draft with redacted output. By default, get hides raw editor state, raw documents, and shared snippets; use --show-secrets only when complete contents are required and protect the output as credentials. --dry-run reports intent only; it is not a codec validation or a final-file diff.

See ochcli editor --help and ochcli editor apply --help for the installed command’s options.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close