Fivexer Console API
The console API from Fivexer — 54 operation(s) for console.
Operations 77
PUT
/console/workspaces/{workspaceId}/sandbox/synthetic
Configure sandbox synthetic-data generation
#
GET
/console/workspaces/{workspaceId}/migration-preview
Preview what would be copied to a new production workspace
#
POST
/console/workspaces/{workspaceId}/api-keys
Issue an API key (live env requires verified email)
#
GET
/console/workspaces/{workspaceId}/usage
Monthly matched-task usage, newest first (current month is live)
#
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
#
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
#
GET
/console/workspaces/{workspaceId}/voice
Voice calling configuration (TURN credentials redacted)
#
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)
#
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}/roster/site-owner-candidates
List the workspace members who can own a site
#
POST
/console/workspaces/{workspaceId}/supervisors
Grant supervisor access, optionally scoped to one crew
#
POST
/console/workspaces/{workspaceId}/supervisors/self-link
Mint a supervisor sign-in link for the signed-in console user
#
POST
/console/workspaces/{workspaceId}/supervisors/{supervisorId}/link
Mint a single-use sign-in link (invalidates any previous one)
#
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)
#
POST
/console/workspaces/{workspaceId}/join-links
Create a QR join link for worker self-registration
#
GET
/console/workspaces/{workspaceId}/join-links
List QR join links (tokens are never returned after creation)
#
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)
#
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)
#
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)
#
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
#