---
title: "Extract structured data from a URL or text using a natural-language prompt. On a locally-run MCP server this defaults to local Ollama; provider \"openai\" or \"anthropic\" use cloud models."
method: POST
path: "/tools/extract_with_llm"
tags: ["tools"]
---

# Extract structured data from a URL or text using a natural-language prompt. On a locally-run MCP server this defaults to local Ollama; provider "openai" or "anthropic" use cloud models.

`POST /tools/extract_with_llm`

## Request

- Base URL: `https://www.crawlforge.dev/api/v1`
- URL: `https://www.crawlforge.dev/api/v1/tools/extract_with_llm`
- Auth: API key in header `X-API-Key`

## Request body

- union
  - object
    - `url` string, required: URL to fetch and extract from (one of url/content required)
    - `content` string: Pre-fetched text to extract from (one of url/content required)
    - `prompt` string, required: Natural-language extraction instruction
    - `schema` object: Optional JSON-schema for output shape (used as Ollama structured-outputs format when provider is "ollama")
    - `provider` 'openai' | 'anthropic' | 'ollama' | 'auto': LLM provider. "auto" prefers a local Ollama instance where one exists; "openai"/"anthropic" use cloud models (require the matching API key on the execution side)
    - `model` string: Override the model. For ollama, pass a name returned by list_ollama_models. Defaults: openai="gpt-4o-mini", anthropic="claude-haiku-4-5-20251001", ollama="llama3.2"
    - `maxTokens` number: Maximum output tokens
  - object
    - `url` string: URL to fetch and extract from (one of url/content required)
    - `content` string, required: Pre-fetched text to extract from (one of url/content required)
    - `prompt` string, required: Natural-language extraction instruction
    - `schema` object: Optional JSON-schema for output shape (used as Ollama structured-outputs format when provider is "ollama")
    - `provider` 'openai' | 'anthropic' | 'ollama' | 'auto': LLM provider. "auto" prefers a local Ollama instance where one exists; "openai"/"anthropic" use cloud models (require the matching API key on the execution side)
    - `model` string: Override the model. For ollama, pass a name returned by list_ollama_models. Defaults: openai="gpt-4o-mini", anthropic="claude-haiku-4-5-20251001", ollama="llama3.2"
    - `maxTokens` number: Maximum output tokens

## Response `200`

The tool's result; 3 credits charged (see x-credits-note and x-extra for add-ons).

- ToolSuccess: The envelope every tool returns on success. Credits are deducted only after the tool succeeded, so credits_used is the price of this call and an error response never charges.
  - `success` true, required
  - `data` object, required: The tool's result. Its shape is tool-specific and documented on the tool's docs page (x-docs-url on the operation).
  - `credits_used` integer, required: Credits charged for this call: the operation's x-credits, plus any add-on x-credits-note or x-extra describes.
  - `credits_remaining` integer, required: The account's credit balance after this call.
  - `processing_time` integer, required: Server-side processing time in milliseconds.
  - `warnings` string[]: Non-fatal notes: a robots.txt override that was recorded, a format that could not be produced, a redaction that changed the payload.

## Other responses

- `400`: VALIDATION_ERROR: the body does not match the request schema.
- `401`: MISSING_API_KEY or INVALID_API_KEY.
- `402`: INSUFFICIENT_CREDITS: the balance does not cover the tool's base price. X-Auto-Recharge-Triggered says whether an automatic recharge was started; retry once it lands.
- `429`: RATE_LIMIT_EXCEEDED: your plan's rate limit. Retry-After: 60.
- `500`: TOOL_ERROR, INTERNAL_ERROR or CREDIT_DEDUCTION_FAILED.
- `default`: Any other error. Which of 403, 404, 413, 422, 501, 502, 503 and 504 a tool can return depends on what it does (fetching a page, calling the execution backend, reading stored results); the code vocabulary is listed on the ErrorResponse schema.

---

[API](https://skmtc.dev/crawlforge/apis/crawlforge-rest-api.md) · [All operations](https://skmtc.dev/crawlforge/apis/crawlforge-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlforge/apis/crawlforge-rest-api/revisions/a5532fa8d5d5?raw)