Fivexer Knowledge API
The knowledge API from Fivexer — 21 operation(s) for knowledge.
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-knowledge-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 Knowledge 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: Knowledge
paths:
/public/knowledge/g/{shareId}:
get:
summary: A shared knowledge graph
tags:
- Knowledge
parameters:
- schema:
type: string
pattern: ^[A-Za-z0-9_-]{22}$
in: path
name: shareId
required: true
responses:
'200':
description: Default Response
operationId: getPublicKnowledgeGByShareId
x-operation-id-source: derived
/public/knowledge/g/{shareId}/nodes/{node}:
get:
summary: One canvas of a shared knowledge graph
tags:
- Knowledge
parameters:
- schema:
type: string
pattern: ^[A-Za-z0-9_-]{22}$
in: path
name: shareId
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: node
required: true
responses:
'200':
description: Default Response
operationId: getPublicKnowledgeGByShareIdNodesByNode
x-operation-id-source: derived
/public/knowledge/g/{shareId}/events:
post:
summary: Report views and feedback on a shared graph
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
minItems: 1
maxItems: 10
items:
type: object
additionalProperties: false
required:
- node
- kind
properties:
node:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
kind:
type: string
enum:
- view
- dwell
- followed
- helpful
- confusing
- wrong
- not-relevant
blockId:
type: string
maxLength: 64
value:
type: integer
minimum: 0
maximum: 86400
note:
type: string
maxLength: 1000
parameters:
- schema:
type: string
pattern: ^[A-Za-z0-9_-]{22}$
in: path
name: shareId
required: true
responses:
'200':
description: Default Response
operationId: postPublicKnowledgeGByShareIdEvents
x-operation-id-source: derived
/public/knowledge/asset/{token}:
get:
summary: A stored image of a canvas
tags:
- Knowledge
parameters:
- schema:
type: string
maxLength: 64
in: path
name: token
required: true
responses:
'200':
description: Default Response
operationId: getPublicKnowledgeAssetByToken
x-operation-id-source: derived
/public/knowledge/html/{token}:
get:
summary: One html block of a canvas, served sandboxed
tags:
- Knowledge
parameters:
- schema:
type: string
enum:
- light
- dark
in: query
name: theme
required: false
- schema:
type: string
maxLength: 64
in: path
name: token
required: true
responses:
'200':
description: Default Response
operationId: getPublicKnowledgeHtmlByToken
x-operation-id-source: derived
/public/knowledge/screens/{token}:
get:
summary: 'A live screen: waits up to 25 s for something newer than `after`'
tags:
- Knowledge
parameters:
- schema:
type: integer
minimum: 0
in: query
name: after
required: false
- schema:
type: integer
minimum: 0
maximum: 25000
in: query
name: waitMs
required: false
- schema:
type: string
maxLength: 64
in: path
name: token
required: true
responses:
'200':
description: Default Response
operationId: getPublicKnowledgeScreensByToken
x-operation-id-source: derived
/public/knowledge/screens/{token}/events:
post:
summary: Report views and feedback from a live screen
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
minItems: 1
maxItems: 10
items:
type: object
additionalProperties: false
required:
- node
- kind
properties:
node:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
kind:
type: string
enum:
- view
- dwell
- followed
- helpful
- confusing
- wrong
- not-relevant
blockId:
type: string
maxLength: 64
value:
type: integer
minimum: 0
maximum: 86400
note:
type: string
maxLength: 1000
parameters:
- schema:
type: string
maxLength: 64
in: path
name: token
required: true
responses:
'200':
description: Default Response
operationId: postPublicKnowledgeScreensByTokenEvents
x-operation-id-source: derived
/v1/knowledge/graphs:
get:
summary: List knowledge graphs with their health
tags:
- Knowledge
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1KnowledgeGraphs
x-operation-id-source: derived
post:
summary: Create a knowledge graph
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- title
properties:
slug:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
title:
type: string
minLength: 1
maxLength: 200
description:
type:
- string
- 'null'
maxLength: 2000
agent:
type:
- string
- 'null'
minLength: 1
maxLength: 128
visibility:
type: string
enum:
- private
- workspace
- link
- public
layers:
type: array
minItems: 1
maxItems: 12
items:
type: string
minLength: 1
maxLength: 80
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1KnowledgeGraphs
x-operation-id-source: derived
/v1/knowledge/graphs/{graph}:
get:
summary: A graph with its nodes and edges
tags:
- Knowledge
parameters:
- schema:
type: boolean
in: query
name: archived
required: false
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1KnowledgeGraphsByGraph
x-operation-id-source: derived
patch:
summary: 'Change a graph: title, visibility, layers, auto-archive, or rotate its share…'
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
title:
type: string
minLength: 1
maxLength: 200
description:
type:
- string
- 'null'
maxLength: 2000
agent:
type:
- string
- 'null'
minLength: 1
maxLength: 128
visibility:
type: string
enum:
- private
- workspace
- link
- public
autoArchive:
type: boolean
layers:
type: array
minItems: 1
maxItems: 12
items:
type: string
minLength: 1
maxLength: 80
rotateShareLink:
type: boolean
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: patchV1KnowledgeGraphsByGraph
x-operation-id-source: derived
delete:
summary: Delete a graph and every canvas in it — permanently
tags:
- Knowledge
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: deleteV1KnowledgeGraphsByGraph
x-operation-id-source: derived
/v1/knowledge/graphs/{graph}/nodes/{node}:
put:
summary: 'Write a canvas: the whole scene becomes the node’s next version (creates the…'
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- title
- scene
properties:
title:
type: string
minLength: 1
maxLength: 200
summary:
type:
- string
- 'null'
maxLength: 1000
layer:
type: integer
minimum: 0
maximum: 11
parent:
type:
- string
- 'null'
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
pos:
type: object
additionalProperties: false
required:
- x
- y
properties:
x:
type: number
minimum: -1000000
maximum: 1000000
y:
type: number
minimum: -1000000
maximum: 1000000
reviewBy:
type:
- string
- 'null'
pattern: ^\d{4}-\d{2}-\d{2}$
visibility:
type: string
enum:
- inherit
- private
scene:
type: object
baseVersion:
type: integer
minimum: 0
createGraph:
type: object
additionalProperties: false
properties:
title:
type: string
minLength: 1
maxLength: 200
agent:
type: string
minLength: 1
maxLength: 128
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: node
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: putV1KnowledgeGraphsByGraphNodesByNode
x-operation-id-source: derived
patch:
summary: Patch a canvas by block id against the version it was read at; placement-only…
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
baseVersion:
type: integer
minimum: 1
upsert:
type: array
maxItems: 200
items:
type: object
remove:
type: array
maxItems: 200
items:
type: string
maxLength: 64
size:
type:
- object
- 'null'
title:
type: string
minLength: 1
maxLength: 200
summary:
type:
- string
- 'null'
maxLength: 1000
pos:
type: object
additionalProperties: false
required:
- x
- y
properties:
x:
type: number
minimum: -1000000
maximum: 1000000
y:
type: number
minimum: -1000000
maximum: 1000000
reviewBy:
type:
- string
- 'null'
pattern: ^\d{4}-\d{2}-\d{2}$
visibility:
type: string
enum:
- inherit
- private
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: node
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: patchV1KnowledgeGraphsByGraphNodesByNode
x-operation-id-source: derived
get:
summary: 'Read a canvas: the node, its scene (current or a given version) and its links'
tags:
- Knowledge
parameters:
- schema:
type: integer
minimum: 1
in: query
name: version
required: false
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: node
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1KnowledgeGraphsByGraphNodesByNode
x-operation-id-source: derived
delete:
summary: Delete a canvas and all its versions — permanently
tags:
- Knowledge
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: node
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: deleteV1KnowledgeGraphsByGraphNodesByNode
x-operation-id-source: derived
/v1/knowledge/graphs/{graph}/nodes/{node}/versions:
get:
summary: A canvas’s version history, newest first
tags:
- Knowledge
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: node
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1KnowledgeGraphsByGraphNodesByNodeVersions
x-operation-id-source: derived
/v1/knowledge/graphs/{graph}/nodes/{node}/restore:
post:
summary: Make an earlier version current again (as a new version)
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- version
properties:
version:
type: integer
minimum: 1
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: node
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1KnowledgeGraphsByGraphNodesByNodeRestore
x-operation-id-source: derived
/v1/knowledge/graphs/{graph}/nodes/{node}/archive:
post:
summary: 'Archive a canvas: its link still opens, it no longer comes back from search'
tags:
- Knowledge
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: node
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1KnowledgeGraphsByGraphNodesByNodeArchive
x-operation-id-source: derived
/v1/knowledge/graphs/{graph}/nodes/{node}/unarchive:
post:
summary: Bring an archived canvas back into use
tags:
- Knowledge
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: node
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1KnowledgeGraphsByGraphNodesByNodeUnarchive
x-operation-id-source: derived
/v1/knowledge/graphs/{graph}/edges:
put:
summary: 'Link two canvases: expands (one layer deeper), depends or cites'
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- from
- to
- kind
properties:
from:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
to:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
kind:
type: string
enum:
- expands
- relates
- depends
- cites
label:
type:
- string
- 'null'
maxLength: 120
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: putV1KnowledgeGraphsByGraphEdges
x-operation-id-source: derived
delete:
summary: Remove a link between two canvases
tags:
- Knowledge
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: query
name: from
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: query
name: to
required: true
- schema:
type: string
enum:
- expands
- relates
- depends
- cites
in: query
name: kind
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: path
name: graph
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: deleteV1KnowledgeGraphsByGraphEdges
x-operation-id-source: derived
/v1/knowledge/search:
get:
summary: Find the passages that answer a question, grouped by canvas, with a citation…
tags:
- Knowledge
parameters:
- schema:
type: string
minLength: 1
maxLength: 500
in: query
name: q
required: true
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: query
name: graph
required: false
- schema:
type: integer
minimum: 1
maximum: 25
in: query
name: limit
required: false
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1KnowledgeSearch
x-operation-id-source: derived
/v1/knowledge/index:
get:
summary: 'How much of the workspace’s knowledge is searchable: live canvases, their…'
tags:
- Knowledge
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1KnowledgeIndex
x-operation-id-source: derived
/v1/knowledge/events:
post:
summary: 'Report how canvases are used: views, dwell, follows and feedback'
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- events
properties:
events:
type: array
minItems: 1
maxItems: 50
items:
type: object
additionalProperties: false
required:
- graph
- node
- kind
properties:
graph:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
node:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
kind:
type: string
enum:
- view
- dwell
- retrieved
- shown
- followed
- helpful
- confusing
- wrong
- not-relevant
blockId:
type: string
maxLength: 64
value:
type: integer
minimum: 0
maximum: 86400
note:
type: string
maxLength: 1000
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1KnowledgeEvents
x-operation-id-source: derived
/v1/knowledge/attention:
get:
summary: 'Knowledge that needs a look: stale, low-trust, duplicate, orphaned or unused…'
tags:
- Knowledge
parameters:
- schema:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
in: query
name: graph
required: false
- schema:
type: integer
minimum: 1
maximum: 200
in: query
name: limit
required: false
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1KnowledgeAttention
x-operation-id-source: derived
/v1/knowledge/screens:
post:
summary: 'Open a live screen: a link a person keeps open while you show them canvases'
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type:
- object
- 'null'
additionalProperties: false
properties:
label:
type: string
minLength: 1
maxLength: 120
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1KnowledgeScreens
x-operation-id-source: derived
/v1/knowledge/screens/{screen}/show:
post:
summary: Put a canvas on a live screen, optionally scrolled to one block
tags:
- Knowledge
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- graph
- node
properties:
graph:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
node:
type: string
pattern: ^[a-z0-9][a-z0-9-]{0,79}$
maxLength: 80
focus:
type: string
maxLength: 64
note:
type: string
maxLength: 500
parameters:
- schema:
type: string
maxLength: 64
in: path
name: screen
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1KnowledgeScreensByScreenShow
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