Fivexer Console API

The console API from Fivexer — 54 operation(s) for console.

Operations 77

GET /console/workspaces/{workspaceId}/audit-events Access log for this workspace #
GET /console/me Current user + memberships #
PATCH /console/me Update the signed-in user’s preferences #
POST /console/verification/resend Re-send the verification email #
GET /console/workspaces Workspaces across all memberships #
POST /console/workspaces Create a production workspace (verified email required) #
POST /console/workspaces/{workspaceId}/sandbox/reset Load, reload or wipe the sandbox demo data #
GET /console/workspaces/{workspaceId}/sandbox/synthetic Read the sandbox synthetic-data settings #
PUT /console/workspaces/{workspaceId}/sandbox/synthetic Configure sandbox synthetic-data generation #
GET /console/workspaces/{workspaceId}/onboarding Console first-run state + activation stamp #
PATCH /console/workspaces/{workspaceId}/onboarding Resolve console first-run state #
POST /console/workspaces/{workspaceId}/onboarding/steps Record a first-run screen as reached #
GET /console/workspaces/{workspaceId}/migration-preview Preview what would be copied to a new production workspace #
POST /console/workspaces/{workspaceId}/migrate Migrate a sandbox to a new production workspace #
POST /console/workspaces/{workspaceId}/api-keys Issue an API key (live env requires verified email) #
GET /console/workspaces/{workspaceId}/api-keys Key metadata (never secrets) #
GET /console/workspaces/{workspaceId}/usage Monthly matched-task usage, newest first (current month is live) #
GET /console/workspaces/{workspaceId}/connections MCP apps connected to this workspace over OAuth #
DELETE /console/workspaces/{workspaceId}/connections/{grantId} Disconnect an MCP app — every token it holds stops working #
DELETE /console/workspaces/{workspaceId} Delete a workspace and all its data (owner role) — irreversible #
PATCH /console/workspaces/{workspaceId} Rename a workspace (owner role) #
DELETE /console/api-keys/{id} Revoke an API key (owner role) #
PUT /console/workspaces/{workspaceId}/webhook Set (or replace) the workspace webhook endpoint #
DELETE /console/workspaces/{workspaceId}/webhook Remove the workspace webhook endpoint #
GET /console/workspaces/{workspaceId}/navigation Which sidebar rows this workspace shows #
PUT /console/workspaces/{workspaceId}/navigation Set the sidebar preset and per-item overrides #
GET /console/workspaces/{workspaceId}/matching Current balancer policy (fairness mode + optional window cap) #
PUT /console/workspaces/{workspaceId}/matching Set the balancer policy — takes effect on the next match pass #
GET /console/workspaces/{workspaceId}/decisions-config Confidence thresholds for machine suggestions #
PUT /console/workspaces/{workspaceId}/decisions-config Set the confidence thresholds #
GET /console/workspaces/{workspaceId}/learning Current learning configuration #
PUT /console/workspaces/{workspaceId}/learning Set the reinforcement-learning configuration #
GET /console/workspaces/{workspaceId}/voice Voice calling configuration (TURN credentials redacted) #
PUT /console/workspaces/{workspaceId}/voice Enable or disable supervisor↔worker voice calls #
GET /console/workspaces/{workspaceId}/policy-defaults Workspace-level escalation and SLA defaults #
PUT /console/workspaces/{workspaceId}/policy-defaults Set default escalation/SLA policies for tasks that declare none #
POST /console/workspaces/{workspaceId}/data-plane/test Test a BYO Redis connection without saving (owner role) #
PUT /console/workspaces/{workspaceId}/data-plane Point the workspace at a BYO Redis (owner role) #
DELETE /console/workspaces/{workspaceId}/data-plane Return the workspace to the managed cell (owner role) #
GET /console/workspaces/{workspaceId}/agent-results Whether AI agents’ results are kept: the workspace default and each agent that… #
PUT /console/workspaces/{workspaceId}/agent-results Set whether AI agents’ results are kept, unless an agent says otherwise (owner… #
PUT /console/workspaces/{workspaceId}/agent-results/{workerId} Set one agent’s result write-back; null follows the workspace default (owner… #
POST /console/workspaces/{workspaceId}/workers/{workerId}/identity Create a worker identity and PIN for the portal #
PATCH /console/workspaces/{workspaceId}/workers/{workerId}/identity Update a worker identity (PIN, label, status) #
DELETE /console/workspaces/{workspaceId}/workers/{workerId}/identity Delete a worker identity and all its sessions #
GET /console/workspaces/{workspaceId}/worker-identities List worker identities for the portal #
GET /console/workspaces/{workspaceId}/roster/site-owner-candidates List the workspace members who can own a site #
GET /console/workspaces/{workspaceId}/supervisors List supervisors and crew leads #
POST /console/workspaces/{workspaceId}/supervisors Grant supervisor access, optionally scoped to one crew #
DELETE /console/workspaces/{workspaceId}/supervisors/{supervisorId} Revoke supervisor access (kills live sessions and push) #
POST /console/workspaces/{workspaceId}/worker-identities/invite Invite a worker by email with a set-your-own-PIN magic link #
POST /console/workspaces/{workspaceId}/worker-identities/{workerId}/invite/resend Mint a fresh invite link for a pending identity (invalidates old links) #
DELETE /console/workspaces/{workspaceId}/join-links/{id} Revoke a QR join link immediately #
POST /console/workspaces/{workspaceId}/portal/publish Publish a new immutable portal version (owner role) #
POST /console/workspaces/{workspaceId}/portal/versions/{version}/publish Roll back: make a retained portal version current (owner role) #
GET /console/workspaces/{workspaceId}/portal Current portal status: URL, version, config #
DELETE /console/workspaces/{workspaceId}/portal Remove the worker portal bundle and all versions (owner role) #
PUT /console/workspaces/{workspaceId}/portal/enabled Enable or disable the worker portal (owner role) #
GET /console/workspaces/{workspaceId}/portal/versions Portal version history (newest first) #
POST /console/workspaces/{workspaceId}/portal/brand-assets Upload the portal app icon source (owner role) #
GET /console/workspaces/{workspaceId}/portal/brand-assets/{assetId} Preview URL for an uploaded portal app icon #
DELETE /console/workspaces/{workspaceId}/portal/brand-assets/{assetId} Delete an uploaded portal app icon source (owner role) #
POST /console/workspaces/{workspaceId}/portal/studio/sessions Start an AI portal studio session #
GET /console/workspaces/{workspaceId}/portal/studio/sessions List live AI portal studio sessions #
GET /console/workspaces/{workspaceId}/portal/studio/usage Metered AI studio agent usage (tokens, turns, durations) #
GET /console/workspaces/{workspaceId}/portal/studio/sessions/{sessionId} AI portal studio session status #
DELETE /console/workspaces/{workspaceId}/portal/studio/sessions/{sessionId} End an AI portal studio session and tear down its sandbox #
POST /console/workspaces/{workspaceId}/portal/studio/sessions/{sessionId}/messages Send a chat instruction to the studio agent #
GET /console/workspaces/{workspaceId}/portal/studio/sessions/{sessionId}/turn-progress Live progress of the in-flight studio agent turn #
POST /console/workspaces/{workspaceId}/portal/studio/sessions/{sessionId}/cancel Stop a specific studio agent turn #
GET /console/workspaces/{workspaceId}/portal/studio/sessions/{sessionId}/preview-status Whether the session's live preview is serving yet #
POST /console/workspaces/{workspaceId}/portal/studio/sessions/{sessionId}/restart Rebuild a studio session's sandbox (transcript kept, unpublished edits lost) #
POST /console/workspaces/{workspaceId}/portal/studio/sessions/{sessionId}/publish Publish the studio session through the versioned portal pipeline #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/5xer-com:5xer-com-console-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

5xer-com-console-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fivexer Platform Console API
  description: 'Routing-as-a-service: create workers and tasks, the platform matches continuously. `/v1` authenticates with a workspace API key (`Authorization: Bearer sk_...`); `/console` with a session token from `/auth`; `/admin` with the operator token.'
  version: 0.1.0
servers:
- url: https://5xer.com
  description: This deployment
tags:


# --- truncated at 32 KB (66 KB total) ---
# Full source: https://artifacts.apis.io/5xer-com/openapi/5xer-com-console-api-openapi.yml