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

usewrit-app Crawl API

Dragnet whole-site crawl — start/list/poll/cancel; pages aggregate under a synthetic workflow.

usewrit-app Crawl 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 Crawl. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 11 operations across 7 paths, and defines 13 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.

11 operations 7 paths 13 schemas 1 DELETE5 GET1 PATCH4 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 Crawl 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 11

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

crawl 11

Dragnet whole-site crawl — start/list/poll/cancel; pages aggregate under a synthetic workflow.

GET
/v1/crawl
List crawls
listCrawls 1 param → 200401
POST
/v1/crawl
Start a crawl
startCrawl body → 200400401
GET
/v1/crawl/{id}
Get one crawl
getCrawl 1 param → 200401404
POST
/v1/crawl/{id}/cancel
Request cancellation of a crawl
cancelCrawl 1 param → 200401404
GET
/v1/crawl/definitions
List saved crawls
listCrawlDefinitions 1 param → 200401
POST
/v1/crawl/definitions
Save a crawl configuration
saveCrawlDefinition body → 201400401
GET
/v1/crawl/definitions/{ref}
Get one saved crawl
getCrawlDefinition 1 param → 200401404
PATCH
/v1/crawl/definitions/{ref}
Update a saved crawl
updateCrawlDefinition 1 param body → 200401404
DELETE
/v1/crawl/definitions/{ref}
Delete a saved crawl
deleteCrawlDefinition 1 param → 204401404
POST
/v1/crawl/definitions/{ref}/run
Run a saved crawl (with optional freshness reuse)
runCrawlDefinition 2 params body → 200202401404504
GET
/v1/crawl/definitions/{ref}/data
Read what a saved crawl already collected
getCrawlDefinitionData 2 params → 200401404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are CrawlJob (33 properties), CrawlStartRequest (15 properties), CrawlDefinition (12 properties), SavedCrawlRun (7 properties). Each schema is shown below with its type and property counts.

CrawlCancelResult
The refreshed crawl view plus cancelrequestednow — true iff this cancel call flipped a live crawl into stopping, false when it was already terminal.
CrawlDefinition
object
A SAVED crawl — a stored crawl configuration with a stable slug. A CrawlJob is one RUN and its id dies with that run, so this is what makes a crawl callable an…
12 properties 4 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
CrawlDefinitionList
object
The saved-crawl list payload (non-Page — a definitions array).
1 property 1 required
RunSavedCrawlBody
object
DELIVERY controls only — the crawl settings are the saved ones.
4 properties
CrawlJob
object
A Dragnet crawl job (crawljobs row), in the toview projection: the JSON-TEXT scope columns are parsed into arrays, and the Dragnet brand, the dataworkflowid al…
33 properties 24 required
SavedCrawlData
object
A pure read of a saved crawl's latest completed run; never crawls.
5 properties 1 required
CrawlDataTable
object
A page of a crawl's collected rows, in the Workflow Data API's shape.
4 properties
SaveCrawlBody
object
Supply exactly one of config / fromcrawlid.
6 properties
CrawlStartRequest
object
Start a Dragnet whole-site crawl. Only url is required; every other field falls to the column default. includepaths/excludepaths are path-regex allow/deny list…
15 properties 1 required
CacheStamp
object
Freshness provenance. Stamped into the BODY, not only into headers, because an MCP tool or SDK client receives a payload and would never see a header.
3 properties 1 required
SavedCrawlRun
object
Two shapes behind one call. On a freshness HIT (cached: true) data is inline and nothing was crawled. On a MISS a crawl was dispatched and data is absent.
7 properties 3 required
CrawlList
object
The Dragnet crawl list payload (non-Page — a crawls array).
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs usewrit-app publishes across the network.

usewrit-app Agent API
usewrit-app Automations API
usewrit-app Cloud API
usewrit-app Data API
usewrit-app Datasets API
usewrit-app Extractors API
usewrit-app Files API
usewrit-app Keys API
usewrit-app Monitors API
usewrit-app Personas API
usewrit-app Runs API
usewrit-app Secrets API
Where this information came from

This is an independent, third-party profile of usewrit-app Crawl 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.