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.
https://api.rubikyt.com. Interviews, traders, webhooks, API keys and integrations.Own techYou implement six read only routes on your platform. Field by field, including the live check. Start here if you do not run Axcera.AxceraAxcera customer search, exact detail and scoped retrieval of accounts, recent trades and payouts.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.
| Method | Path | Scope | |
|---|---|---|---|
| GET | /v1/interviews | interviews:read | List with filters and organization KPIs. |
| POST | /v1/interviews | interviews:create | Create an interview. Returns the invite URL. |
| GET | /v1/interviews/{id} | interviews:read | Interview, report, transcript, integrity events, activity. |
| GET | /v1/interviews/{id}/diagnostics | interviews:read | Technical 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}/archive | interviews:decide | Archive or restore an interview without changing evaluated usage. |
| POST | /v1/interviews/{id}/decision | interviews:decide | Record approved, rejected or needs_review. |
| POST | /v1/interviews/{id}/share | interviews:decide | Create a read only share link. Body expires_hours. |
| DELETE | /v1/interviews/{id}/share | interviews:decide | Revoke the share link. |
| POST | /v1/interviews/{id}/reissue | interviews:create | Fresh invite before recording, including after consent. Optional window_hours and idempotency_key. |
| POST | /v1/interviews/{id}/retake | interviews:create | New attempt after completion or failure. Optional idempotency_key. |
| POST | /v1/interviews/{id}/interrupt-and-retake | interviews:create | Interrupt an active attempt and create one replacement; preserve its saved recordings. |
| POST | /v1/interviews/{id}/regenerate | interviews:create | Queue a new report. |
| POST | /v1/interviews/{id}/playback | interviews:read | Short lived signed HLS URLs. Refresh before expiry. |
| GET | /v1/interviews/{id}/subtitles | interviews:read | WebVTT captions. 404 until they exist. |
| POST | /v1/interviews/{id}/subtitles | interviews:create | Queue caption generation. |
| POST | /v1/interviews/{id}/activity-file | interviews:create | Upload an unambiguous activity export directly; otherwise use preview and confirmation. |
| POST | /v1/interviews/{id}/activity-file/preview | interviews:create | Preview a CSV, TSV, XLSX, XLS or ODS export. Returns an import ID valid for 24 hours. |
| POST | /v1/interviews/{id}/activity-file/confirm | interviews:create | Confirm the import ID, column mappings and required reconstruction assumptions. |
| GET | /v1/interviews/{id}/activity-file/preview/{import_id} | interviews:read | Resume a saved preview within 24 hours without uploading or analyzing it again. |
| DELETE | /v1/interviews/{id}/activity-file/preview/{import_id} | interviews:create | Cancel an unconfirmed preview and restore the committed evidence. |
| GET | /v1/interviews/{id}/activity-file | interviews:read | Download the uploaded activity file. |
| POST | /v1/interviews/{id}/assign | interviews:decide | Body user_id, or null to unassign. |
| PATCH | /v1/interviews/{id}/communication | interviews:decide | Body { 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.
| Method | Path | Scope | |
|---|---|---|---|
| GET | /v1/traders | traders:read | Paginated saved CRM records. Filter with search. |
| GET | /v1/traders/search | traders:read | Search 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/import | traders:read + traders:write | Body integration_id and external_id. Fetch and save only the selected trader and their activity. |
| POST | /v1/traders | traders:write | Create a trader: full_name, optional email, external_id, country, phone, tags. |
| GET | /v1/traders/{id} | traders:read | Profile, accounts, payouts, notes, interviews, stats. |
| PATCH | /v1/traders/{id} | traders:write | Update identity fields or status. |
| GET | /v1/traders/{id}/trades | traders:read | Paginated trades for one trader. |
| POST | /v1/traders/{id}/notes | traders:write | Body { body }. Internal note. |
| DELETE | /v1/traders/{id}/notes/{noteId} | traders:write | Delete a note. |
Webhooks
Event payloads, signature verification and retries are on Webhooks.
| Method | Path | Scope | |
|---|---|---|---|
| GET | /v1/webhooks | webhooks:manage | List endpoints. |
| GET | /v1/webhooks/events | webhooks:manage | Event catalog with descriptions. |
| POST | /v1/webhooks/check | webhooks:manage | Verify your backend with a challenge. Body url. No secret is generated. |
| POST | /v1/webhooks | webhooks:manage | Verify and create. Body url and events. Generates the signing secret only after successful verification. |
| PATCH | /v1/webhooks/{id} | webhooks:manage | Update url, events or is_active. |
| DELETE | /v1/webhooks/{id} | webhooks:manage | Delete an endpoint. |
| POST | /v1/webhooks/{id}/test | webhooks:manage | Send a ping delivery. |
| POST | /v1/webhooks/{id}/rotate-secret | webhooks:manage | Rotate the signing secret. Shown once. |
| GET | /v1/webhooks/{id}/deliveries | webhooks:manage | Delivery history, paginated. |
| POST | /v1/webhooks/deliveries/{deliveryId}/retry | webhooks:manage | Retry 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
| Field | Type | Description |
|---|---|---|
name | string | Required. A label for the dashboard. |
scopes | Permission[] | Required. At least one scope. Unknown scopes are rejected. |
expires_in_days | number | null | Optional expiry. Omit for a key that does not expire. |
The response includes secret, shown once, prefixed with rubi_live_.
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
| Field | Type | Description |
|---|---|---|
kind | axcera | custom_api | Required. custom_api is Own tech. |
base_url | string | Required. Axcera Open API origin, or your Own tech base URL. HTTPS, no trailing slash. |
api_key | string | Required. Bearer token. Stored encrypted. Only a preview is returned afterwards. |
name | string | null | Label. Defaults from the kind. |
account_scope | object | null | Axcera only. plan_category_ids as string resource IDs and platforms as vendor names such as MT5 or CTrader. Other keys are rejected. |
sync_interval_seconds | number | null | Legacy compatibility field. Ignored for scheduling; retrieval happens only on trader selection. |
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"
}'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.
| Method | Path | Scope | |
|---|---|---|---|
| GET | /health | Bearer key | status must be ok |
| GET | /traders | Bearer key | provider search, id and updated_at required |
| GET | /traders/{id} | Bearer key | one trader, 404 when unknown |
| GET | /accounts | Bearer key | mandatory trader_id filter |
| GET | /trades | Bearer key | mandatory account_id, recent open and closed trades |
| GET | /payouts | Bearer key | mandatory trader_id when supported; 404 skips payouts |
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.
| Method | Path | Scope | |
|---|---|---|---|
| GET | /v1/customers | Axcera key | Bounded provider search; no import. |
| GET | /v1/customers/{id} | Axcera key | Exact selected customer profile. |
| GET | /v1/prop-accounts | Axcera key | Search by customer email, then enforce customer ownership and configured scope. |
| GET | /v1/prop-accounts/{id} | Axcera key | Verify selected account identity and scope from its exact detail. |
| GET | /v1/trades/closed | Axcera key | customer_ids and account_ids; close_time_gte for the last 90 days. |
| GET | /v1/trades/open | Axcera key | customer_ids and account_ids; all current open positions for selected accounts. |
| GET | /v1/payouts | Axcera key | customer_id ownership filter; optional 404 skips payouts. |