# octocrawl-dev API

**Canonical:** https://apis.io/apis/octocrawl-dev/octocrawl-dev-api/  
**Provider:** octocrawl-dev — https://apis.io/providers/octocrawl-dev/  
**Base URL:** https://api.octocrawl.dev  
**Documentation:** https://octocrawl.dev/docs/reference

octocrawl-dev API is one of 2 APIs that [octocrawl-dev](https://apis.io/providers/octocrawl-dev/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

octocrawl-dev API as documented publicly: 31 operations. Contract generated from the documentation by API Evangelist (2026-10-30); not the provider's own document.

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| GET | `/.well-known/mcp/server-card.json` | Smithery's server card listing the server's name, version, and authentication requirements. |
| GET | `/api/account/activity` | Retrieve the signed-in account's activity log and request history. |
| POST | `/api/account/run` | Run a scrape or map for the signed-in account without requiring an API key. |
| GET | `/api/capability` | Reads the planned route and limitation for a given URL using a query parameter. |
| POST | `/api/capability` | Reads the planned route and limitation for a given URL using a JSON body with the URL. |
| GET | `/api/quota` | Reads the preview quota remaining for the current visitor without spending anything. |
| POST | `/crawl` | Submit a hosted crawl task with multiple URLs to run asynchronously in the cloud. |
| GET | `/health` | Health check endpoint. |
| POST | `/internal/jobs/{id}/slice` | Execute one slice of a hosted job. |
| POST | `/mcp-oauth` | OAuth sign-in endpoint where the client sends Authorization: Bearer oca_… token. |
| POST | `/v1/batches` | Scrape an explicit URL array. |
| GET | `/v1/batches/{id}` | Retrieve a batch job's status and results by its ID. |
| POST | `/v1/batches/{id}/cancel` | Cancel a running batch job. |
| POST | `/v1/batches/{id}/handoff` | Hand off a stopped batch page to the user's Chrome to get through a check. |
| GET | `/v1/batches/{id}/items` | Get paginated outcomes from a batch. |
| POST | `/v1/crawl` | Crawl by following links. |
| GET | `/v1/crawl/{id}` | Get a crawl by ID. |
| POST | `/v1/crawl/{id}/cancel` | Cancel a running crawl job. |
| GET | `/v1/crawl/{id}/pages` | Paginate through the pages of a crawl job. |
| GET | `/v1/jobs` | List job tools. |
| GET | `/v1/jobs/{id}/export` | Get a signed URL to download the complete export of a finished job. |
| GET | `/v1/logins` | List the saved logins. |
| DELETE | `/v1/logins/{site}` | Forget a saved login for a site. |
| POST | `/v1/logins/import` | Import a login for a site from Chrome's saved credentials. |
| POST | `/v1/map` | Map a site's URLs. |
| GET | `/v1/maps/{id}` | Get a map result by ID. |
| PATCH | `/v1/projects` | PATCH /v1/projects |
| POST | `/v1/read` | Read a page with the hosted browser lane and return its result. |
| GET | `/v1/scrape` | GET /v1/scrape |
| POST | `/v1/scrape` | Scrape one URL. |
| GET | `/v1/scrapes/{id}` | Get a scrape result by ID. |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/octocrawl-dev/openapi/_ae-authored/octocrawl-dev-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/octocrawl-dev/json-schema/octocrawl-dev-post-crawl-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/octocrawl-dev/json-schema/octocrawl-dev-post-v1-logins-import-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/octocrawl-dev/json-schema/octocrawl-dev-get-api-quota-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/octocrawl-dev/json-schema/octocrawl-dev-post-v1-scrape-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/octocrawl-dev/json-schema/octocrawl-dev-post-v1-logins-import-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/octocrawl-dev/json-schema/octocrawl-dev-get-api-capability-response-schema.json

## Other octocrawl-dev APIs (1)

- [Octocrawl API](https://apis.io/apis/octocrawl-dev/octocrawl-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/octocrawl-dev/octocrawl-dev-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/octocrawl-dev/.