canonical: https://jentic.com/apis/datawebot.com/datawebot

# datawebot. Jobs API

The datawebot Jobs API extracts structured records from a public ecommerce URL using a blueprint, a store-and-operation contract that defines the inputs and output shape for one kind of page. You discover a blueprint, submit a single URL as a Job, then poll that Job for its status, credits, and extracted records instead of parsing raw HTML yourself. Each blueprint publishes its input_schema, record_schema, price, and availability, so you know the exact inputs, output fields, and cost before you spend any credits.

## For AI agents

Discover an extraction blueprint for an ecommerce store, submit a public product URL as a Job, and read back structured records with their job status and credit cost. Turns a live product page into predictable JSON instead of raw HTML.

## Scope

Does not run a storefront, manage orders, or place purchases. Use for extracting structured data from public ecommerce URLs only.

## Capabilities

- Discover extraction blueprints across supported ecommerce stores and resolve a target URL to its store
- Submit one public product URL as a Job against a chosen blueprint_id and extract structured records
- Poll a Job by id for status, credits charged, and poll_after_seconds guidance until it finishes
- Page through a finished Job's records with cursor and page_size
- Read wallet balance and month-to-date Job usage by blueprint for the API key's account

## Use cases

### Agent-Driven Product Data Extraction

An AI agent that needs live product data calls the datawebot Jobs API through Jentic: it discovers the right blueprint for a store, submits a single public product URL as a Job with that blueprint_id, then polls the Job by id and reads the extracted records against the blueprint's record_schema. Each Job extracts one URL under a store-and-operation contract, so the agent gets predictable structured output instead of raw HTML, and each Job reports its billing_status and credits.

Example prompt: Resolve a product URL to its blueprint, submit a Job with that blueprint_id and url, poll the job id until status is finished, and return the extracted records

### Blueprint Discovery and Store Matching

Before extracting, an application lists available blueprints or searches by store to find the contract that fits a target URL. The datawebot Jobs API returns each blueprint's input_schema, record_schema, price, and availability, so a developer knows the exact inputs, output shape, and cost before spending any credits. The search endpoint also resolves a raw target URL to its store, removing guesswork about which blueprint to use.

Example prompt: Search blueprints with the target set to a product URL and return the matching blueprint_id, input_schema, and price

### Usage and Credit Monitoring

A team running many extractions tracks spend by reading the account wallet balance and month-to-date Job totals broken down by blueprint. The datawebot Jobs API exposes the account balance and a usage summary since the start of the current UTC month, so an agent can check remaining credits before submitting a batch of Jobs. This keeps automated extraction inside a known budget.

Example prompt: Read the account wallet balance and the current month usage by blueprint, then decide whether to submit more Jobs

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v1/jobs` | Submit one public URL as one extraction Job |
| GET | `/v1/jobs/{id}` | Get Job status, credits, and poll guidance |
| GET | `/v1/jobs/{id}/results` | Read one page of a finished Job's records |
| GET | `/v1/job-blueprints` | List extraction blueprints across supported stores |
| GET | `/v1/job-blueprints/search` | Search stores or resolve a target URL to its store |
| GET | `/v1/jobs` | List your Jobs, newest first |
| GET | `/v1/account` | Get wallet balance for the account |
| GET | `/v1/usage` | Get month-to-date Job totals by blueprint |

## Key resources

- **Blueprints** — Discover and search extraction contracts; each exposes input_schema, record_schema, price, and availability
- **Jobs** — Submit one URL per Job, list Jobs, and poll a Job by id for status, credits, and results
- **Account** — Read wallet balance and month-to-date usage by blueprint for the API key's account

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 83 / 100
  - Developer Experience & Jentic Compatibility: 69 / 100
  - AI-Readiness & Agent Experience: 48 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 67 / 100
- **View full report:** https://jentic.com/apis/datawebot.com/datawebot/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the datawebot Jobs API by hand means handling its dwb_ bearer key, discovering the right blueprint, sending an Idempotency-Key on every Job submit, and polling each Job by id until it finishes. Through Jentic you install once, import it from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Datawebot carries the blueprint and target URL in the Job request body, so rules bound which operations your agent may call, not which store or URL it may extract. You choose the operations it may call, so you can allow blueprint discovery and reading Job results while leaving Job submission, which spends credits, out unless you add it.
- **Credential handling:** Your datawebot API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'extract product data from a URL' or 'list extraction blueprints', and Jentic returns the matching datawebot operation with its input schema so the agent sends the right blueprint_id and url without reading the reference docs.

## Related APIs

- **Firecrawl** — Crawls and converts any website into clean structured data, versus blueprint-defined extraction of specific ecommerce stores.
- **Diffbot** — Extracts structured product, article, and entity data from web pages with its own classification models.
- **ZenRows** — A scraping API that fetches and parses pages with proxy and anti-bot handling, versus contract-based ecommerce extraction.
- **Apify** — A platform of reusable scraping actors that can feed URLs into an extraction pipeline.

## FAQ

### What authentication does the datawebot Jobs API use?

The datawebot Jobs API authenticates with a bearer API key, a dwb_ token sent in the Authorization header on every request, per its OpenAPI spec. Through Jentic the key is stored encrypted by your own Jentic One instance and injected at call time, so it never appears in a URL or in the agent's logs.

### Can I extract data from any ecommerce URL with the datawebot Jobs API?

You extract a public URL by first discovering a blueprint that covers its store and operation, then submitting the URL as a Job with that blueprint_id. Coverage is defined by the available blueprints, each of which lists its input_schema, record_schema, price, and availability, so extraction works for the stores those blueprints support rather than for arbitrary sites.

### What are the rate limits for the datawebot Jobs API?

The OpenAPI spec does not specify request rate limits; Jobs are metered in credits per page fetched, and a submitted Job returns a poll_after_seconds value telling you when to check it next. For current limits and credit pricing, see the datawebot documentation at https://www.datawebot.com.

### How do I run an extraction Job through Jentic?

Search Jentic with a query like 'extract product data from a URL', add the datawebot Jobs API from the directory, and store your dwb_ key once. Your agent discovers a blueprint, submits the URL to the Job submit operation with the matching blueprint_id, and polls the Job by id until its records are ready. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the datawebot Jobs API?

Yes. Write a rule that allows only the read operations, such as listing blueprints and reading Job results, so the agent can discover contracts and fetch finished records but cannot submit new Jobs that spend credits, and every call it makes is logged. Because the blueprint and URL travel in the request body, scoping controls which operations run, not which store the agent may target.

### Is there a datawebot MCP server?

Yes, datawebot offers its operations as MCP tools. You can also connect the datawebot Jobs API directly through Jentic: your agent gets the full 8-endpoint surface without loading another server's tool definitions into its context, your dwb_ key is injected at call time by your self-hosted instance instead of living in a config file, and your rules decide which operations the agent may call.