Fivexer Runs API
The runs API from Fivexer — 11 operation(s) for runs.
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-runs-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 Runs 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: Runs
paths:
/v1/runs:
post:
summary: 'Open an agent run: a goal the caller will pursue, with every action recorded…'
tags:
- Runs
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- goal
properties:
goal:
type: string
minLength: 1
maxLength: 2000
goalKey:
type: string
minLength: 1
maxLength: 128
pattern: ^[a-z0-9][a-z0-9._-]*$
inputs:
type: object
mode:
type: string
enum:
- discover
- workflow
workflowId:
type: string
minLength: 1
maxLength: 128
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: postV1Runs
x-operation-id-source: derived
get:
summary: List agent runs, newest first
tags:
- Runs
parameters:
- schema:
type: string
enum:
- running
- blocked
- done
- failed
- abandoned
in: query
name: status
required: false
- schema:
type: string
maxLength: 128
in: query
name: goalKey
required: false
- schema:
type: integer
minimum: 1
maximum: 200
in: query
name: limit
required: false
- schema:
type: integer
minimum: 0
in: query
name: before
required: false
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1Runs
x-operation-id-source: derived
/v1/runs/{id}:
get:
summary: An agent run, with the question it is waiting on if it is blocked
tags:
- Runs
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: getV1RunsById
x-operation-id-source: derived
/v1/runs/{id}/events:
get:
summary: A run’s recorded events after a seq — optionally long-polled until there are…
tags:
- Runs
parameters:
- schema:
type: integer
minimum: 0
in: query
name: after
required: false
- schema:
type: integer
minimum: 1
maximum: 1000
in: query
name: limit
required: false
- schema:
type: integer
minimum: 0
maximum: 25000
in: query
name: waitMs
required: false
- schema:
type: string
in: path
name: id
required: true
security:
- apiKey: []
responses:
'200':
description: Default Response
operationId: getV1RunsByIdEvents
x-operation-id-source: derived
/v1/runs/{id}/tasks:
get:
summary: Every task a run created or ran, with who did it and where it stands
tags:
- Runs
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: getV1RunsByIdTasks
x-operation-id-source: derived
/v1/tasks/{id}/run:
get:
summary: The agent run a task was part of — its step and why it was created
tags:
- Runs
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: getV1TasksByIdRun
x-operation-id-source: derived
/v1/runs/{id}/decisions:
post:
summary: Record a choice the agent made, and why — branches of a saved workflow come…
tags:
- Runs
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- why
- chose
properties:
why:
type: string
minLength: 1
maxLength: 1000
chose:
type: string
minLength: 1
maxLength: 200
basedOn:
type: object
additionalProperties: false
required:
- taskId
- field
properties:
taskId:
type: string
minLength: 1
maxLength: 128
field:
type: string
minLength: 1
maxLength: 64
pattern: ^\w+$
value: {}
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: postV1RunsByIdDecisions
x-operation-id-source: derived
/v1/runs/{id}/notes:
post:
summary: Record reasoning the agent did outside 5xer that a reviewer would need
tags:
- Runs
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- text
properties:
text:
type: string
minLength: 1
maxLength: 4000
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: postV1RunsByIdNotes
x-operation-id-source: derived
/v1/runs/{id}/blockers:
post:
summary: Stop and ask a person — only when the run cannot go on without one
tags:
- Runs
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- question
properties:
question:
type: string
minLength: 1
maxLength: 1000
options:
type: array
maxItems: 6
items:
type: string
minLength: 1
maxLength: 200
taskId:
type: string
minLength: 1
maxLength: 128
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: postV1RunsByIdBlockers
x-operation-id-source: derived
/v1/runs/{id}/workflow:
post:
summary: Save a finished run as a fixed workflow — or, with dryRun, see what it would be…
tags:
- Runs
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
workflowId:
type: string
minLength: 1
maxLength: 128
name:
type: string
minLength: 1
maxLength: 200
dryRun:
type: boolean
replace:
type: boolean
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: postV1RunsByIdWorkflow
x-operation-id-source: derived
/v1/runs/{id}/finish:
post:
summary: Close a run with its outcome
tags:
- Runs
requestBody:
required: true
content:
application/json:
schema:
type: object
additionalProperties: false
required:
- success
properties:
success:
type: boolean
summary:
type: string
minLength: 1
maxLength: 2000
result:
type: object
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: postV1RunsByIdFinish
x-operation-id-source: derived
/v1/runs/{id}/abandon:
post:
summary: Give a run up without an outcome
tags:
- Runs
security:
- apiKey: []
parameters:
- schema:
type: string
in: path
name: id
required: true
responses:
'200':
description: Default Response
operationId: postV1RunsByIdAbandon
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