Install
openclaw skills install @byungkyu/firecrawl-apiFirecrawl API integration with managed authentication. Scrape, crawl, map, and search web content. Use this skill when users want to extract content from websites, crawl entire sites, map URLs, or search the web. For other third party apps, use the api-gateway skill (https://clawhub.ai/byungkyu/api-gateway). Calls run through the maton CLI with OAuth login, or over raw HTTP with a Maton API key where the CLI cannot be installed. The endpoints documented here are the intended surface, not a technical limit — the maton api passthrough can reach others the connection permits. Default to read and list calls, and confirm every write or new connection with the user.
openclaw skills install @byungkyu/firecrawl-apiAccess the Firecrawl API with managed authentication. Scrape webpages, crawl entire websites, map site URLs, and search the web with full content extraction.
All access runs through the Maton gateway and the maton CLI.
maton login --oauth # authenticate once (OAuth, recommended)
maton connection create firecrawl # connect the account (needs user approval)
maton api '/firecrawl/v2/crawl/active' # first call
npm install -g @maton/cli
brew install maton-ai/cli/maton
maton login --oauth
Opens the OAuth login page in the browser and waits for authorization. Once complete, it creates a profile in config.toml (eg. $HOME/.config/maton/config.toml) and stores the access and refresh tokens in the operating system's credential store (Keychain on macOS, Credential Manager on Windows, Secret Service on Linux), auto-renewed on expiry. The CLI reads them when it needs them; nothing else should.
maton login --interactive
Requires manually copying an API key from Settings, which is error prone. Once complete, it also creates a profile in config.toml and stores the key in the same credential store. It is preferred over export MATON_API_KEY=..., which exposes a long-lived credential to every child process. When MATON_API_KEY is set, it overrides the active profile. If the CLI cannot be installed at all, see Appendix: Environments Without the CLI for the raw HTTP form and the rules for handling the key.
maton whoami --json
{
"authenticated": true,
"profile_name": "alice@example.com",
"auth_type": "oauth"
}
authenticated is false, stop and login again via maton login --oauth.auth_type is api_key, it is recommended to login via maton login --oauth and avoid keeping a long-lived credential.maton connection list firecrawl --status ACTIVE
{
"connections": [
{
"connection_id": "{connection_id}",
"status": "ACTIVE",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "firecrawl",
"method": "OAUTH2",
"metadata": {}
}
]
}
Refer to maton connection list --help for possible flags and values.
Requires explicit user approval. Confirm that the user intends to authorize Firecrawl access before running this. Never create a connection on your own initiative.
maton connection create firecrawl
Refer to maton connection create --help for possible flags and values.
maton connection get {connection_id}
{
"connection": {
"connection_id": "{connection_id}",
"status": "PENDING",
"creation_time": "2025-12-08T07:20:53.488460Z",
"last_updated_time": "2026-01-31T20:03:32.593153Z",
"url": "https://connect.maton.ai/?session_token=5e9...",
"app": "firecrawl",
"metadata": {}
}
}
Open the returned URL in a browser to complete authorizing Firecrawl. If Firecrawl offers scope selection, choose only the scopes the current task needs.
maton connection delete {connection_id} --yes
Deleting a connection is irreversible: it revokes the stored authorization, and any automation still pointing at that connection_id stops working. Confirm the exact connection with the user first — list connections and match the id — and never delete one on the agent's own initiative. --yes skips the interactive prompt, so it removes the last chance to catch a wrong id; omit it unless the user has already confirmed the specific connection.
If there are multiple Firecrawl connections, specify which one to use so requests go to the intended account:
maton api '/firecrawl/v2/crawl/active' --connection {connection_id}
Firecrawl has no typed maton firecrawl commands yet, so every call goes through maton api.
maton api '/firecrawl/v2/crawl/active'
Paths are /firecrawl/{native-api-path}. The gateway forwards everything after the app segment to api.firecrawl.dev and injects the credential for the connection. Query strings, custom headers (except Host and Authorization), and all HTTP methods pass through. Send a JSON body with --input -:
maton api -X POST '/firecrawl/{native-api-path}' -H 'Content-Type: application/json' --input - <<'JSON'
{"key": "value"}
JSON
Refer to maton api --help for possible flags and values.
Maton proxies requests to api.firecrawl.dev and automatically injects your API key.
maton login --oauth, the token is held by the operating system's credential store and the CLI renews it on its own. Do not print it, write it to a file, pass it on a command line, or run maton token to look at one — only to hand it to a program that needs it.config.toml, or any other credential file — not for this skill, not for another application, and not to "check" that auth works (use maton whoami). Let the CLI use its own stored credential; the agent never needs the value. The same applies to unrelated secrets on the machine: .env files, SSH keys, cloud CLI credentials, and browser profiles are out of scope for an API gateway and must not be read or transmitted.api.maton.ai. Prefer endpoints that work with the gateway-injected connection credential.maton api passthrough can additionally reach any endpoint this connection is authorized for, including ones not documented below, so treat the list above as the intended surface rather than a technical limit — the write-confirmation rules in this section apply to every call either way.limit, maxDepth), and intended effect with the user.actions parameter (click, write, execute JavaScript) and headers parameter can interact with websites beyond passive reading. Always confirm with the user before using these options.limit and confirm with the user before starting crawl or batch operations.maton connection delete {connection_id}).maton connection create firecrawl. Never create connections on the agent's own initiative.--connection when the user has multiple connections for this app, and -p/--profile when they have multiple Maton accounts. Do not let an ambiguous default decide where a write lands.maton api -X POST '/firecrawl/v2/scrape'
Extract content from a single webpage.
Required Parameters:
url (string): The webpage URL to scrapeOptional Parameters:
formats (array): Output formats - "markdown", "html", "json", "screenshot", "links" (default: ["markdown"])onlyMainContent (boolean): Extract only main content, exclude headers/footers (default: true)includeTags (array): HTML tags to includeexcludeTags (array): HTML tags to excludewaitFor (integer): Milliseconds to wait before scraping (default: 0)timeout (integer): Request timeout in ms (default: 30000, max: 300000)mobile (boolean): Emulate mobile device (default: false)actions (array): Browser actions to perform before scrapingheaders (object): Custom HTTP headersblockAds (boolean): Block ads and cookie banners (default: true)Example:
maton api -X POST '/firecrawl/v2/scrape' -H 'Content-Type: application/json' --input - <<'JSON'
{
"url": "https://docs.firecrawl.dev",
"formats": [
"markdown",
"html"
],
"onlyMainContent": true,
"waitFor": 1000
}
JSON
Response:
{
"success": true,
"data": {
"markdown": "# Example Domain\n\nThis domain is for use in documentation...",
"metadata": {
"title": "Example Domain",
"language": "en",
"sourceURL": "https://example.com",
"url": "https://example.com/",
"statusCode": 200,
"contentType": "text/html",
"creditsUsed": 1
}
}
}
maton api -X POST '/firecrawl/v2/crawl'
Start crawling an entire website. Returns a crawl ID for status polling.
Required Parameters:
url (string): The base URL to start crawling fromOptional Parameters:
limit (integer): Maximum pages to crawl (default: 10000)maxDepth (integer): Maximum crawl depthincludePaths (array): Regex patterns for URLs to includeexcludePaths (array): Regex patterns for URLs to excludeallowSubdomains (boolean): Enable subdomain crawlingallowExternalLinks (boolean): Follow external linksscrapeOptions (object): Options for each page scrape (formats, onlyMainContent, etc.)webhook (string): Webhook URL for completion notificationExample:
maton api -X POST '/firecrawl/v2/crawl' -H 'Content-Type: application/json' --input - <<'JSON'
{
"url": "https://example.com",
"limit": 10,
"scrapeOptions": {
"formats": [
"markdown"
]
}
}
JSON
Response:
{
"success": true,
"id": "019cdc53-0acf-76ec-a80c-3ead753b2730",
"url": ".../v1/crawl/019cdc53-0acf-76ec-a80c-3ead753b2730"
}
maton api '/firecrawl/v2/crawl/{id}'
Get the status and results of a crawl job.
Path Parameters:
id (string): The crawl job IDExample:
maton api '/firecrawl/v2/crawl/019cdc53-0acf-76ec-a80c-3ead753b2730'
Response:
{
"success": true,
"status": "completed",
"completed": 2,
"total": 2,
"creditsUsed": 2,
"expiresAt": "2026-03-12T09:56:00.000Z",
"data": [
{
"markdown": "# Example Domain\n\nThis domain is for use in documentation...",
"metadata": {
"title": "Example Domain",
"sourceURL": "https://example.com",
"statusCode": 200
}
}
]
}
Status Values:
scraping - Crawl in progresscompleted - Crawl finished successfullyfailed - Crawl failedmaton api '/firecrawl/v2/crawl/{id}' -X DELETE
Cancel an in-progress crawl job.
Path Parameters:
id (string): The crawl job IDExample:
maton api '/firecrawl/v2/crawl/019cdc53-0acf-76ec-a80c-3ead753b2730' -X DELETE
Response:
{
"success": true,
"status": "cancelled"
}
maton api -X POST '/firecrawl/v2/map'
Get all URLs from a website without scraping content.
Required Parameters:
url (string): The starting URLOptional Parameters:
search (string): Query to order results by relevancelimit (integer): Maximum links to return (default: 5000, max: 100000)includeSubdomains (boolean): Include subdomains (default: true)sitemap (string): Sitemap handling - "skip", "include", "only" (default: "include")ignoreQueryParameters (boolean): Exclude URLs with query params (default: true)timeout (integer): Timeout in millisecondsExample:
maton api -X POST '/firecrawl/v2/map' -H 'Content-Type: application/json' --input - <<'JSON'
{
"url": "https://docs.firecrawl.dev",
"limit": 100,
"includeSubdomains": false
}
JSON
Response:
{
"success": true,
"links": [
"https://docs.firecrawl.dev",
"https://docs.firecrawl.dev/api-reference",
"https://docs.firecrawl.dev/introduction"
]
}
maton api -X POST '/firecrawl/v2/search'
Search the web and get full page content for each result.
Required Parameters:
query (string): Search query (max 500 characters)Optional Parameters:
limit (integer): Number of results (default: 5, max: 100)sources (array): Search types - "web", "images", "news" (default: ["web"])country (string): ISO country code (the API defaults to "US" — that is Firecrawl's default, not a setting this skill mandates; pass the region the user asked for, and ask when it is not stated)location (string): Geographic targeting (e.g., "Germany")tbs (string): Time filter - "qdr:d" (day), "qdr:w" (week), "qdr:m" (month), "qdr:y" (year)timeout (integer): Timeout in ms (default: 60000)scrapeOptions (object): Options for content extractionExample:
maton api -X POST '/firecrawl/v2/search' -H 'Content-Type: application/json' --input - <<'JSON'
{
"query": "web scraping best practices",
"limit": 5,
"scrapeOptions": {
"formats": [
"markdown"
]
}
}
JSON
Response:
{
"success": true,
"data": [
{
"url": "https://example.com/article",
"title": "Web Scraping Best Practices",
"description": "Learn the best practices for web scraping...",
"markdown": "# Web Scraping Best Practices\n\n..."
}
],
"creditsUsed": 5
}
maton api -X POST '/firecrawl/v2/batch/scrape'
Scrape multiple URLs in a single batch job.
Required Parameters:
urls (array): List of URLs to scrapeOptional Parameters:
formats (array): Output formats (default: ["markdown"])onlyMainContent (boolean): Extract only main content (default: true)webhook (string): Webhook URL for completion notificationExample:
maton api -X POST '/firecrawl/v2/batch/scrape' -H 'Content-Type: application/json' --input - <<'JSON'
{
"urls": [
"https://example.com",
"https://example.org"
],
"formats": [
"markdown"
]
}
JSON
Response:
{
"success": true,
"id": "019cdc59-56b9-7096-a9f9-95fcc92a3a75",
"url": ".../v1/batch/scrape/019cdc59-56b9-7096-a9f9-95fcc92a3a75"
}
maton api '/firecrawl/v2/batch/scrape/{id}'
Get the status and results of a batch scrape job.
Path Parameters:
id (string): The batch scrape job IDExample:
maton api '/firecrawl/v2/batch/scrape/019cdc59-56b9-7096-a9f9-95fcc92a3a75'
Response:
{
"success": true,
"status": "completed",
"completed": 2,
"total": 2,
"creditsUsed": 2,
"expiresAt": "2026-03-12T10:02:54.000Z",
"data": [
{
"markdown": "# Example Domain\n\n...",
"metadata": {
"title": "Example Domain",
"sourceURL": "https://example.com",
"statusCode": 200
}
}
]
}
maton api '/firecrawl/v2/batch/scrape/{id}' -X DELETE
Cancel an in-progress batch scrape job.
Path Parameters:
id (string): The batch scrape job IDmaton api '/firecrawl/v2/batch/scrape/{id}/errors'
Get errors from a batch scrape job.
Path Parameters:
id (string): The batch scrape job IDResponse:
{
"errors": [],
"robotsBlocked": []
}
maton api '/firecrawl/v2/crawl/{id}/errors'
Get errors from a crawl job.
Path Parameters:
id (string): The crawl job IDExample:
maton api '/firecrawl/v2/crawl/019cdc53-0acf-76ec-a80c-3ead753b2730/errors'
Response:
{
"errors": [],
"robotsBlocked": []
}
maton api '/firecrawl/v2/crawl/active'
Get all active crawl jobs.
Example:
maton api '/firecrawl/v2/crawl/active'
Response:
{
"success": true,
"crawls": []
}
maton api -X POST '/firecrawl/v2/extract'
Extract structured data from URLs using AI.
Required Parameters:
urls (array): List of URLs to extract fromprompt (string): Natural language description of what to extractOptional Parameters:
schema (object): JSON schema for structured outputscrapeOptions (object): Options for scrapingExample:
maton api -X POST '/firecrawl/v2/extract' -H 'Content-Type: application/json' --input - <<'JSON'
{
"urls": [
"https://example.com"
],
"prompt": "Extract the main heading and description"
}
JSON
Response:
{
"success": true,
"id": "019cdc59-977b-774b-b584-af2af45c055b",
"urlTrace": []
}
maton api '/firecrawl/v2/extract/{id}'
Get the status and results of an extract job.
Path Parameters:
id (string): The extract job IDExample:
maton api '/firecrawl/v2/extract/019cdc59-977b-774b-b584-af2af45c055b'
Response:
{
"success": true,
"data": [
{
"heading": "Example Domain",
"description": "This domain is for use in documentation..."
}
],
"status": "completed",
"expiresAt": "2026-03-11T16:03:05.000Z"
}
maton api -X POST '/firecrawl/v2/browser'
Create an interactive browser session for manual control via CDP.
Example:
maton api -X POST '/firecrawl/v2/browser' -H 'Content-Type: application/json' --input - <<'JSON'
{}
JSON
Response:
{
"success": true,
"id": "019cdc5d-5c9d-732e-a7bd-f095a96a2bb1",
"cdpUrl": "wss://browser.firecrawl.dev/cdp/...",
"liveViewUrl": "https://liveview.firecrawl.dev/...",
"interactiveLiveViewUrl": "https://liveview.firecrawl.dev/...",
"expiresAt": "2026-03-11T10:17:12.409Z"
}
maton api '/firecrawl/v2/browser'
List all active browser sessions.
Example:
maton api '/firecrawl/v2/browser'
Response:
{
"success": true,
"sessions": [
{
"id": "019cdc5d-5c9d-732e-a7bd-f095a96a2bb1",
"status": "active",
"cdpUrl": "wss://browser.firecrawl.dev/cdp/...",
"liveViewUrl": "https://liveview.firecrawl.dev/..."
}
]
}
maton api '/firecrawl/v2/browser/{id}' -X DELETE
Delete a browser session.
Path Parameters:
id (string): The browser session IDmaton api -X POST '/firecrawl/v2/agent'
Start an AI agent to autonomously navigate and extract data.
Required Parameters:
prompt (string): Description of what data to extract (max 10,000 chars)Optional Parameters:
urls (array): URLs to constrain the agent toschema (object): JSON schema for structured outputmaxCredits (integer): Maximum credits to use (default: 2500)strictConstrainToURLs (boolean): Only visit provided URLsmodel (string): "spark-1-mini" (default, cheaper) or "spark-1-pro" (higher accuracy)Example:
maton api -X POST '/firecrawl/v2/agent' -H 'Content-Type: application/json' --input - <<'JSON'
{
"prompt": "Find the pricing information",
"urls": [
"https://example.com"
],
"model": "spark-1-mini"
}
JSON
Response:
{
"success": true,
"id": "019cdc5d-a2d4-728c-9c91-e9eae475568f"
}
maton api '/firecrawl/v2/agent/{id}'
Get the status and results of an agent job.
Path Parameters:
id (string): The agent job IDExample:
maton api '/firecrawl/v2/agent/019cdc5d-a2d4-728c-9c91-e9eae475568f'
Response:
{
"success": true,
"status": "completed",
"model": "spark-1-pro",
"data": {...},
"expiresAt": "2026-03-12T10:07:30.055Z"
}
maton api '/firecrawl/v2/agent/{id}' -X DELETE
Cancel an in-progress agent job.
Path Parameters:
id (string): The agent job IDUse actions parameter to interact with pages before scraping:
maton api -X POST '/firecrawl/v2/scrape' -H 'Content-Type: application/json' --input - <<'JSON'
{
"url": "https://example.com",
"formats": [
"markdown",
"screenshot"
],
"actions": [
{
"type": "wait",
"milliseconds": 2000
},
{
"type": "click",
"selector": "#load-more"
},
{
"type": "scroll",
"direction": "down",
"amount": 500
},
{
"type": "screenshot"
}
]
}
JSON
Available Actions:
wait - Wait for specified millisecondsclick - Click an element by CSS selectorwrite - Type text into an input fieldscroll - Scroll the pagescreenshot - Take a screenshotexecute - Run custom JavaScriptonlyMainContent: true to get cleaner output without navigation/footerThe CLI above is this skill's documented path; the SDKs are an optional way to call the same gateway from application code. The two modes keep separate credential stores: the CLI uses the profile from maton login, while an SDK program signs in once with login(), which opens a browser and stores a session that Maton() reads. Firecrawl has no typed accessor yet, so calls go through the api passthrough, which takes the app and the path after it.
Python
pip install maton-ai
from maton_ai import Maton, login
# login()
maton = Maton()
# maton = Maton(api_key="...")
result = maton.api.get("firecrawl", "/v2/crawl/active")
JavaScript
npm install @maton/sdk
import { Maton, login } from "@maton/sdk";
// await login()
const maton = new Maton();
// const maton = new Maton({ apiKey: "..." });
const result = await maton.api.get("firecrawl", "/v2/crawl/active");
| Status | Meaning |
|---|---|
| 400 | Missing Firecrawl connection |
| 401 | Invalid, missing, or expired Maton credential |
| 429 | Rate limited (10 requests/second per account) |
| 500 | Internal Server Error |
| 4xx/5xx | Passthrough error from the Firecrawl API |
Errors from Firecrawl are passed through with their original status codes and response bodies.
maton whoami --json
"authenticated": false — login again with maton login --oauth."auth_type": "api_key" — prefer maton login --oauth so no long-lived key sits on the machine.maton whoami is the check.Then confirm the app is connected:
maton connection list firecrawl --status ACTIVE
Paths passed to maton api must start with /firecrawl/:
maton api '/firecrawl/v2/crawl/active'maton api '/v2/crawl/active'A 500 may mean the Firecrawl authorization expired. With the user's approval, create a new connection (maton connection create firecrawl) and complete authorization; once it is ACTIVE, delete the stale connection so the gateway uses the new one.
maton api.--paginate walks every page and -q/--jq trims the response before it reaches you. On typed commands, --jq requires --json.maton api; Host and Authorization are set by the gateway.Everything above uses the CLI, which holds the credential itself and never exposes it to the caller. Use the raw HTTP form below only where the CLI cannot be installed — a locked-down container, a CI step, a sandbox with no package manager. If maton is available, maton api does the same job without handling a secret.
Calling api.maton.ai directly means holding a long-lived Maton API key in the process environment, where it is readable by every child process and easy to leak into logs, crash dumps, shell history, and pasted output. Handle it accordingly:
[ -n "$MATON_API_KEY" ] && echo "MATON_API_KEY is set" || echo "MATON_API_KEY is not set"
.env, or a script makes it permanent. Let the environment that starts the session supply it — a CI secret store, a container secret, a secrets manager.ps output and shell history. Read it from the environment inside the process that makes the request, as below.api.maton.ai. It is not a credential for Firecrawl or any other third-party host.The request is a plain HTTPS call to host api.maton.ai at path /firecrawl/{native-api-path} with a bearer token; the gateway swaps in the connected app's credential. Add a Maton-Connection: {connection_id} header to pin a specific connection when the account has more than one. Query values must be URL-encoded. The Python standard library is enough — the key is read from the environment inside the process, so it never appears on a command line:
python3 - <<'PY'
import json, os, urllib.request
GATEWAY = "https://api.maton.ai"
req = urllib.request.Request(GATEWAY + "/firecrawl/v2/crawl/active")
req.add_header("Authorization", "Bearer " + os.environ["MATON_API_KEY"])
req.add_header("User-Agent", "maton-firecrawl-skill/1.2")
# req.add_header("Maton-Connection", "{connection_id}")
with urllib.request.urlopen(req) as resp:
print(json.dumps(json.load(resp), indent=2))
PY
For a write, set method="POST" (or PUT/DELETE) on the Request, pass the JSON-encoded body as data=, and add a Content-Type: application/json header.
The same rules as the CLI apply to every request made this way: read-only calls first, and explicit user confirmation before any POST, PUT, PATCH, or DELETE.
The example prints the whole response body only to show the call working. Responses can carry personal data — names, email addresses, phone numbers, message and document contents — so extract just the fields the task needs instead of dumping the full payload, and do not write raw responses into logs, files, or anywhere the user has not asked for them.