Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nimbleway Extract API

The Extract API from Nimbleway — 3 operation(s) for extract.

Nimbleway Extract API is one of 11 APIs that Nimbleway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Extract. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://sdk.nimbleway.com.

3 operations 3 paths 16 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://sdk.nimbleway.com/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Nimbleway Extract API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

Paths & Operations 3

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

Extract 3
POST
/v1/extract
Extract
body → 200400402429500
POST
/v1/extract/async
Extract Async
body → 200400402429500
POST
/v1/extract/batch
Extract Batch
body → 200400402429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are ExtractPayload (24 properties), BrowserAction (11 properties), ExtractResponse (7 properties), NetworkCaptureFilter (6 properties). Each schema is shown below with its type and property counts.

ExtractPayload
object
Request body model for the /extract endpoint
24 properties 1 required
AsyncResponse
object
2 properties 2 required
Error400
object
4 properties 2 required
ExtractResponse
object
7 properties 6 required
ExtractBatchPayload
object
2 properties
Parser
object
Custom extraction recipe defining what data to extract and how to structure it. Each property represents a field in the output.
ParserExtractor
PostProcessor
object
Transform extracted data
1 property 1 required
Error429
object
2 properties 2 required
BrowserAction
object
An action to perform in the browser (one of: goto, wait, waitforelement, click, press, fill, scroll, autoscroll, screenshot, getcookies, fetch)
11 properties
ParserSelector
BatchResponse
object
Response when a batch of extract tasks is created successfully.
3 properties
NetworkCaptureFilter
object
Configuration for capturing network requests made by the page
6 properties
Error402
object
2 properties 2 required
AsyncOptions
object
5 properties
Error500
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nimbleway-extract-api-openapi.yml Raw ↑

Other APIs Nimbleway publishes across the network.

Nimbleway Agents API
Nimbleway Crawl API
Nimbleway Domain Knowledge API
Nimbleway Fast SERP API
Nimbleway Jobs API
Nimbleway Map API
Nimbleway Media API
Nimbleway Search API
Nimbleway SERP API
Nimbleway Tasks API