Fivexer Worker Identities API
The worker-identities API from Fivexer — 8 operation(s) for worker-identities.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/5xer-com:5xer-com-worker-identities-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
openapi: 3.2.0
info:
title: Fivexer Platform Worker Identities 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:
- name: worker-identities
paths:
/v1/worker-identities:
get:
summary: List worker portal identities
tags:
- worker-identities
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1WorkerIdentities
x-operation-id-source: derived
/v1/worker-identities/invite:
post:
summary: Invite a worker by email with a set-your-own-PIN magic link
tags:
- worker-identities
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- email
properties:
email:
type: string
format: email
maxLength: 256
workerId:
type: string
minLength: 1
maxLength: 128
label:
type: string
minLength: 1
maxLength: 128
tags:
type: array
items:
type: string
minLength: 1
maxLength: 64
maxItems: 64
skills:
type: array
maxItems: 128
items:
type: object
additionalProperties: false
required:
- skillId
- level
properties:
skillId:
type: string
maxLength: 64
level:
type: number
minimum: 1
maximum: 5
weightOverride:
type: number
minimum: 0
maximum: 100
validFrom:
type:
- string
- 'null'
pattern: ^\d{4}-\d{2}-\d{2}$
validUntil:
type:
- string
- 'null'
pattern: ^\d{4}-\d{2}-\d{2}$
teamIds:
type: array
items:
type: string
maxLength: 64
maxItems: 32
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1WorkerIdentitiesInvite
x-operation-id-source: derived
/v1/worker-identities/{workerId}/invite/resend:
post:
summary: Mint a fresh invite link for a pending identity (invalidates old links)
tags:
- worker-identities
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: workerId
required: true
responses:
'200':
description: Default Response
operationId: postV1WorkerIdentitiesByWorkerIdInviteResend
x-operation-id-source: derived
/v1/workers/{workerId}/identity:
post:
summary: Create a worker identity and PIN for the portal
tags:
- worker-identities
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- label
- pin
properties:
label:
type: string
minLength: 1
maxLength: 128
pin:
type: string
minLength: 4
maxLength: 256
email:
type: string
format: email
maxLength: 256
agent:
type: boolean
description: 'An AI agent, issued as one by this key: it may use the workspace’s knowledge'
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: workerId
required: true
responses:
'200':
description: Default Response
operationId: postV1WorkersByWorkerIdIdentity
x-operation-id-source: derived
patch:
summary: Update a worker identity (PIN, label, email, status)
tags:
- worker-identities
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
minProperties: 1
properties:
label:
type: string
minLength: 1
maxLength: 128
pin:
type: string
minLength: 4
maxLength: 256
email:
type:
- string
- 'null'
format: email
maxLength: 256
status:
type: string
enum:
- active
- revoked
executorKind:
type: string
enum:
- human
- agent
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: workerId
required: true
responses:
'200':
description: Default Response
operationId: patchV1WorkersByWorkerIdIdentity
x-operation-id-source: derived
delete:
summary: Delete a worker identity and all its sessions
tags:
- worker-identities
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: workerId
required: true
responses:
'200':
description: Default Response
operationId: deleteV1WorkersByWorkerIdIdentity
x-operation-id-source: derived
/v1/workers/{workerId}/identity/agent:
post:
summary: Mark a worker’s identity as an AI agent issued by this workspace — it may then…
tags:
- worker-identities
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: workerId
required: true
responses:
'200':
description: Default Response
operationId: postV1WorkersByWorkerIdIdentityAgent
x-operation-id-source: derived
/v1/join-links:
post:
summary: Create a QR join link for worker self-registration
tags:
- worker-identities
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- label
properties:
label:
type: string
minLength: 1
maxLength: 128
teamId:
type: string
maxLength: 64
tags:
type: array
items:
type: string
minLength: 1
maxLength: 64
maxItems: 64
skills:
type: array
maxItems: 128
items:
type: object
additionalProperties: false
required:
- skillId
- level
properties:
skillId:
type: string
maxLength: 64
level:
type: number
minimum: 1
maximum: 5
weightOverride:
type: number
minimum: 0
maximum: 100
validFrom:
type:
- string
- 'null'
pattern: ^\d{4}-\d{2}-\d{2}$
validUntil:
type:
- string
- 'null'
pattern: ^\d{4}-\d{2}-\d{2}$
requiresApproval:
type: boolean
maxUses:
type: number
minimum: 1
maximum: 10000
expiresInMs:
type: number
minimum: 60000
maximum: 7776000000
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1JoinLinks
x-operation-id-source: derived
get:
summary: List QR join links (tokens are never returned after creation)
tags:
- worker-identities
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1JoinLinks
x-operation-id-source: derived
/v1/join-links/{id}:
delete:
summary: Revoke a QR join link immediately
tags:
- worker-identities
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: deleteV1JoinLinksById
x-operation-id-source: derived
/v1/portal:
get:
summary: Worker portal status and login URL
tags:
- worker-identities
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1Portal
x-operation-id-source: derived
components:
securitySchemes:
apiKey:
type: http
scheme: bearer
description: Workspace API key (sk_test_/sk_live_)
session:
type: http
scheme: bearer
description: Console session token (st_...)
adminToken:
type: http
scheme: bearer
description: Operator ADMIN_TOKEN
workerToken:
type: http
scheme: bearer
description: Worker session token (wt_...)
supervisorToken:
type: http
scheme: bearer
description: Supervisor session token (sv_...), scoped to one workspace and optionally one team