Skip to content
RUBI

API reference

Every HTTP contract Rubi ships with. Call the Rubi API to run interviews. Implement Own tech, or connect Axcera, so Rubi can retrieve the selected trader's activity.

Rubi API#

Base URL https://api.rubikyt.com. Send Authorization: Bearer rubi_live_... and Content-Type: application/json on requests with a body. Responses are snake_case JSON. Timestamps are RFC 3339 UTC. Paginated routes take page (1 based) and limit (default 25, maximum 100) and return { data, meta: { page, limit, total } }. API keys, webhook endpoints, the event catalog and integrations return an unpaginated { data } collection.

Errors are application/problem+json: type, title, status, detail, code, and errors on validation failures. See Errors, Authentication and Rate limits (600 requests per minute per key).

Interviews

Full objects, the report schema and examples are on the Interviews API.

MethodPathScope
GET/v1/interviewsinterviews:readList with filters and organization KPIs.
POST/v1/interviewsinterviews:createCreate an interview. Returns the invite URL.
GET/v1/interviews/{id}interviews:readInterview, report, transcript, integrity events, activity.
GET/v1/interviews/{id}/diagnosticsinterviews:readTechnical setup timeline, per-source delivery/publication and question exposure signals. Browser signals are unverified; absence is unknown, never proof of fraud.
PATCH/v1/interviews/{id}/archiveinterviews:decideArchive or restore an interview without changing evaluated usage.
POST/v1/interviews/{id}/decisioninterviews:decideRecord approved, rejected or needs_review.
POST/v1/interviews/{id}/shareinterviews:decideCreate a read only share link. Body expires_hours.
DELETE/v1/interviews/{id}/shareinterviews:decideRevoke the share link.
POST/v1/interviews/{id}/reissueinterviews:createFresh invite before recording, including after consent. Optional window_hours and idempotency_key.
POST/v1/interviews/{id}/retakeinterviews:createNew attempt after completion or failure. Optional idempotency_key.
POST/v1/interviews/{id}/interrupt-and-retakeinterviews:createInterrupt an active attempt and create one replacement; preserve its saved recordings.
POST/v1/interviews/{id}/regenerateinterviews:createQueue a new report.
POST/v1/interviews/{id}/playbackinterviews:readShort lived signed HLS URLs. Refresh before expiry.
GET/v1/interviews/{id}/subtitlesinterviews:readWebVTT captions. 404 until they exist.
POST/v1/interviews/{id}/subtitlesinterviews:createQueue caption generation.
POST/v1/interviews/{id}/activity-fileinterviews:createUpload an unambiguous activity export directly; otherwise use preview and confirmation.
POST/v1/interviews/{id}/activity-file/previewinterviews:createPreview a CSV, TSV, XLSX, XLS or ODS export. Returns an import ID valid for 24 hours.
POST/v1/interviews/{id}/activity-file/confirminterviews:createConfirm the import ID, column mappings and required reconstruction assumptions.
GET/v1/interviews/{id}/activity-file/preview/{import_id}interviews:readResume a saved preview within 24 hours without uploading or analyzing it again.
DELETE/v1/interviews/{id}/activity-file/preview/{import_id}interviews:createCancel an unconfirmed preview and restore the committed evidence.
GET/v1/interviews/{id}/activity-fileinterviews:readDownload the uploaded activity file.
POST/v1/interviews/{id}/assigninterviews:decideBody user_id, or null to unassign.
PATCH/v1/interviews/{id}/communicationinterviews:decideBody { done: true } after you told the trader the outcome.

Traders

Field reference on the Traders API. Imported traders from Own tech or Axcera appear here with source set to custom_api or axcera.

MethodPathScope
GET/v1/traderstraders:readPaginated saved CRM records. Filter with search.
GET/v1/traders/searchtraders:readSearch saved records and active providers. Provider calls start at 2 characters; shorter queries return local records. Optional limit (default 8 per source). No import.
POST/v1/traders/importtraders:read + traders:writeBody integration_id and external_id. Fetch and save only the selected trader and their activity.
POST/v1/traderstraders:writeCreate a trader: full_name, optional email, external_id, country, phone, tags.
GET/v1/traders/{id}traders:readProfile, accounts, payouts, notes, interviews, stats.
PATCH/v1/traders/{id}traders:writeUpdate identity fields or status.
GET/v1/traders/{id}/tradestraders:readPaginated trades for one trader.
POST/v1/traders/{id}/notestraders:writeBody { body }. Internal note.
DELETE/v1/traders/{id}/notes/{noteId}traders:writeDelete a note.

Webhooks

Event payloads, signature verification and retries are on Webhooks.

MethodPathScope
GET/v1/webhookswebhooks:manageList endpoints.
GET/v1/webhooks/eventswebhooks:manageEvent catalog with descriptions.
POST/v1/webhooks/checkwebhooks:manageVerify your backend with a challenge. Body url. No secret is generated.
POST/v1/webhookswebhooks:manageVerify and create. Body url and events. Generates the signing secret only after successful verification.
PATCH/v1/webhooks/{id}webhooks:manageUpdate url, events or is_active.
DELETE/v1/webhooks/{id}webhooks:manageDelete an endpoint.
POST/v1/webhooks/{id}/testwebhooks:manageSend a ping delivery.
POST/v1/webhooks/{id}/rotate-secretwebhooks:manageRotate the signing secret. Shown once.
GET/v1/webhooks/{id}/deliverieswebhooks:manageDelivery history, paginated.
POST/v1/webhooks/deliveries/{deliveryId}/retrywebhooks:manageRetry one delivery.

API keys

Key management requires a signed in dashboard user with api_keys:manage. Send your dashboard session token; an API key cannot create, list or revoke keys.

GET/v1/api-keysapi_keys:manage

Returns { data: ApiKey[] }

Keys without the secret. Each row has id, name, prefix, scopes, created_by_name, created_at, last_used_at, expires_at and revoked_at.

POST/v1/api-keysapi_keys:manage

Returns ApiKeyCreated

FieldTypeDescription
namestringRequired. A label for the dashboard.
scopesPermission[]Required. At least one scope. Unknown scopes are rejected.
expires_in_daysnumber | nullOptional expiry. Omit for a key that does not expire.

The response includes secret, shown once, prefixed with rubi_live_.

bash
curl https://api.rubikyt.com/v1/api-keys \
  -H "Authorization: Bearer $RUBI_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Risk pipeline", "scopes": ["interviews:create", "interviews:read", "traders:read"] }'

DELETE/v1/api-keys/{id}api_keys:manage

Revokes the key immediately. Subsequent authentication attempts fail with 401; requests already authenticated may finish.

Integrations#

Connect Axcera or Own tech from the API. kind is axcera or custom_api. Creating an integration runs the live check and returns it as report. This validates access only. It never starts an initial import or periodic global polling.

GET/v1/integrations/egressintegrations:read

Returns EgressInfo

region, cidrs and a note. Allowlist these ranges on Axcera or on your Own tech API before running the check.

POST/v1/integrations/testintegrations:manage

Returns ConnectionReport

Runs the live check without saving. Same body as create.

POST/v1/integrationsintegrations:manage

Returns IntegrationCreated

FieldTypeDescription
kindaxcera | custom_apiRequired. custom_api is Own tech.
base_urlstringRequired. Axcera Open API origin, or your Own tech base URL. HTTPS, no trailing slash.
api_keystringRequired. Bearer token. Stored encrypted. Only a preview is returned afterwards.
namestring | nullLabel. Defaults from the kind.
account_scopeobject | nullAxcera only. plan_category_ids as string resource IDs and platforms as vendor names such as MT5 or CTrader. Other keys are rejected.
sync_interval_secondsnumber | nullLegacy compatibility field. Ignored for scheduling; retrieval happens only on trader selection.
Own tech
curl https://api.rubikyt.com/v1/integrations \
  -H "Authorization: Bearer $RUBI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "custom_api",
    "name": "Own tech",
    "base_url": "https://risk.example-firm.com/rubi/v1",
    "api_key": "PROVIDER_KEY"
  }'
Axcera
curl https://api.rubikyt.com/v1/integrations \
  -H "Authorization: Bearer $RUBI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "axcera",
    "base_url": "https://openapi.examplefirm.app.axcera.io",
    "api_key": "AXCERA_KEY",
    "account_scope": { "plan_category_ids": ["665f173dc93f9ccd08e12e42"], "platforms": ["MT5"] }
  }'

GET/v1/integrationsintegrations:read

Returns { data: Integration[] }

GET/v1/integrations/{id}integrations:read

Returns Integration

Includes health_status, last_error (code, message, http_status, endpoint, hint), the last retrieval timestamp and counters for imported traders, accounts, trades and payouts. Historical sync fields remain in the response for compatibility.

PATCH/v1/integrations/{id}integrations:manage

Returns Integration

Update name, base_url, api_key, account_scope or is_active. Legacy sync_interval_seconds values do not schedule work.

DELETE/v1/integrations/{id}integrations:manage

Removes the connection. Previously imported traders stay in the CRM.

POST/v1/integrations/{id}/testintegrations:manage

Returns ConnectionReport

Re-runs the live check for a saved connection.

POST/v1/integrations/{id}/syncintegrations:manage

Returns 410 Gone

Retired. No job is queued. Search with GET /v1/traders/search and retrieve a selected trader with POST /v1/traders/import.

GET/v1/integrations/{id}/runsintegrations:read

Returns Page of retrieval runs

Each run has resource, status, records_upserted, error, started_at and finished_at. On-demand retrieval uses resource=trader. Older sync runs remain available.

Own tech#

Your platform implements these routes. Rubi calls them. The pages linked here document every field, enum, error and the exact assertions of the live check.

Read the Own tech pages before you build
The overview covers authentication, mandatory search and ownership filters, cursor pagination and connection validation. Each endpoint page has the request and response contract.

Axcera#

Rubi calls https://openapi.<tenant>.app.axcera.io with your read only key. Search remains ephemeral and retrieval is scoped to the selected customer and accounts. The provider-specific filters are on the Axcera endpoints page. Connecting the key is on the setup guide.

MethodPathScope
GET/v1/customersAxcera keyBounded provider search; no import.
GET/v1/customers/{id}Axcera keyExact selected customer profile.
GET/v1/prop-accountsAxcera keySearch by customer email, then enforce customer ownership and configured scope.
GET/v1/prop-accounts/{id}Axcera keyVerify selected account identity and scope from its exact detail.
GET/v1/trades/closedAxcera keycustomer_ids and account_ids; close_time_gte for the last 90 days.
GET/v1/trades/openAxcera keycustomer_ids and account_ids; all current open positions for selected accounts.
GET/v1/payoutsAxcera keycustomer_id ownership filter; optional 404 skips payouts.