v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB

webdbs

Preview extraction (dry run)

Tests extraction on up to 5 URLs without creating a collection. Each URL costs 1 credit.

post/webdbs/preview

Request body

urlsstring[] required

URLs to test. Maximum 5.

schemaWebdbsSchema required

JSON Schema for the fields extracted into each row. Zod users can pass the output of z.toJSONSchema().

tagsstring[]

Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.

Example request

{
  "schema": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string",
        "description": "Product name."
      },
      "price": {
        "type": "number",
        "description": "Current price."
      }
    },
    "required": [
      "title"
    ],
    "additionalProperties": false
  },
  "eligibility": {
    "prefilter": {
      "url_match": [
        "https://shop.com/products/:product_id",
        "https://foo.com/item?id=*",
        "https://foo.com/bar/*",
        "**/events/**"
      ]
    }
  },
  "tags": [
    "production",
    "team-alpha"
  ]
}

Response

Per-URL preview results