How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
usewrit-app

usewrit-app Runs API

Read-only run feed, per-run results/data, live SSE events, and cancel-by-run-id.

Documentation Provider Profile APIs.io OpenAPI GitHub

usewrit-app Runs API is one of 17 APIs that usewrit-app publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Runs. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 6 operations across 6 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against 2 base URLs: http://127.0.0.1:8131, https://127.0.0.1:8132.

6 operations 6 paths 15 schemas 5 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.usewrit.app
Authentication
HTTP Bearer
License
MIT
Resource Areas
1

Authentication & Security 1

usewrit-app Runs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Every route (including /v1/agent and /v1/health) requires Authorization: Bearer . Token families: - wlt… — the runtime token from runtime.json (full access, us…

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 5 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Runs 6

Read-only run feed, per-run results/data, live SSE events, and cancel-by-run-id.

GET
/v1/runs
List runs (enriched feed)
listRuns 6 params → 200401
GET
/v1/runs/{id}
Get one run
getRun 1 param → 200401404
GET
/v1/runs/{id}/results
Raw run result payload
getRunResults 1 param → 200401404
GET
/v1/runs/{id}/data
Extracted data of one run
getRunData 2 params → 200401404
GET
/v1/runs/{id}/events
Live run event stream (SSE)
streamRunEvents 1 param → 200401404
POST
/v1/runs/{id}/cancel
Cancel a live run by run id
cancelRun 1 param → 202409401404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are RunFeedItem (15 properties), RunEventStep (5 properties), RunEventProgress (4 properties), RunCancelConflict (3 properties). Each schema is shown below with its type and property counts.

RunEvent
One SSE frame's JSON payload, tagged by its event field (which also matches the SSE event: name). finished and error are stream-closing.
RunEventStarted
object
The run is registered and about to drive its steps. totalsteps counts the raw steps the engine will iterate (a synthetic subscription seed may report 0).
3 properties 3 required
RunList
object
{data, count, total} list envelope (runs only).
3 properties 3 required
Error
object
The daemon's domain error body. NOTE: some 4xx responses (axum framework rejections) are text/plain instead of this JSON shape. Certain codes attach extra fiel…
2 properties 2 required
RunCancelAccepted
object
202 body of POST /v1/runs/{id}/cancel.
2 properties 2 required
RunFeedItem
object
Enriched run-feed projection (api/v1/runs.rs::RunFeedItem). id is a COMPOSITE STRING " - " (e.g. "workflow-3"); the numeric id for get/cancel/events is the par…
15 properties 14 required
RunData
object
Extracted-data envelope (JSON lane). data is the extracteddata value of the result payload, falling back to the whole result.
3 properties 3 required
RunCancelConflict
object
409 body of POST /v1/runs/{id}/cancel — the run is terminal or has no live engine handle. runstatus (the row's actual status) is present only on the already-te…
3 properties 2 required
RunEventProgress
object
Coarse progress hint — completed of total steps done.
4 properties 4 required
RunStatus
string
Terminal/in-flight run status (serde snakecase of engine::RunStatus). Treat as an open string enum in clients.
RunEventError
object
TERMINAL: the run failed around the step loop. message is an operator-facing classification, never a raw secret/value. Stream-closing.
3 properties 3 required
RunEventFinished
object
TERMINAL: the run reached a final status. Stream-closing.
3 properties 3 required
RunEventStep
object
A step transitioned. index is 0-based into the raw step list; steptype is the recorded step kind — never a value.
5 properties 5 required
StepStatus
string
Coarse per-step lifecycle marker.
RunResults
object
Raw run result envelope.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

usewrit-app-runs-api-openapi.yml Raw ↑

Other APIs usewrit-app publishes across the network.

usewrit-app Agent API
AE Profile APIs.io
usewrit-app Automations API
AE Profile APIs.io
usewrit-app Cloud API
AE Profile APIs.io
usewrit-app Crawl API
AE Profile APIs.io
usewrit-app Data API
AE Profile APIs.io
usewrit-app Datasets API
AE Profile APIs.io
usewrit-app Extractors API
AE Profile APIs.io
usewrit-app Files API
AE Profile APIs.io
usewrit-app Keys API
AE Profile APIs.io
usewrit-app Monitors API
AE Profile APIs.io
usewrit-app Personas API
AE Profile APIs.io
usewrit-app Secrets API
AE Profile APIs.io
#Runs
← Back to U APIs
API Details
ID
usewrit-app:usewrit-app-runs-api
Base URL
https://api.usewrit.app
Docs
https://usewrit.app/docs/api
Provider
usewrit-app
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=usewrit-app-runs-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/usewrit-app-runs-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of usewrit-app Runs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.