Recent requests
| id |
created_at |
type |
mode |
renderer |
url |
status |
http_status |
duration_ms |
history |
| Save an API key in this browser to load recent requests. |
Endpoints
| method | path | purpose |
|---|
GET | /html?url=<url> | fetch one page as HTML |
GET | /metadata?url=<url> | fetch one page as metadata |
GET | /markdown?url=<url> | fetch one page as markdown |
GET | /screenshot?url=<url>&full_page=true | fetch one page as a screenshot |
GET | /crawl?url=<url>&max_pages=25&max_depth=2&page_mode=metadata | follow links |
GET | /images?url=<url>&min_width=48&min_height=24 | extract page images and logos |
GET | /fields?url=<url>&field=email,telephone | extract requested fields from markdown |
GET | /urls?url=<url>&source=auto&max_pages=250&max_depth=2 | discover page URLs |
GET | /requests?limit=500 | list stored request history with results |
GET | /history/:id | read one stored request result |
Parameters
/html
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
url |
required
|
URL of the page to fetch. |
renderer |
optional
· auto
|
Renderer: auto, agent-browser, or cloudflare. |
/metadata
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
url |
required
|
URL of the page to fetch. |
renderer |
optional
· auto
|
Renderer: auto, agent-browser, or cloudflare. |
/markdown
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
url |
required
|
URL of the page to fetch. |
renderer |
optional
· auto
|
Renderer: auto, agent-browser, or cloudflare. |
/screenshot
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
url |
required
|
URL of the page to fetch. |
renderer |
optional
· auto
|
Renderer: auto, cloudflare, or screenshotbase. Auto uses Cloudflare. |
full_page |
optional
· false
|
Capture the full page. |
/crawl
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
url |
required
|
Start URL for the crawl. |
max_pages |
optional
· 25
|
Maximum pages to crawl. |
max_depth |
optional
· 2
|
Maximum crawl depth. |
same_origin |
optional
· true
|
Restrict to same origin. |
include |
optional
|
Repeated regex filter for allowed URLs. |
exclude |
optional
|
Repeated regex filter for blocked URLs. |
strategy |
optional
· bfs
|
Crawl strategy. |
delay_ms |
optional
· 0
|
Delay between page fetches. |
page_mode |
optional
· metadata
|
Output format per page. |
include_start |
optional
· true
|
Include the start URL in results. |
/images
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
url |
required
|
URL of the page to inspect for images. |
min_width |
optional
· 48
|
Minimum accepted image width in pixels. |
min_height |
optional
· 24
|
Minimum accepted image height in pixels. |
/fields
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
url |
required
|
URL of the page to render and convert to markdown first. |
field |
required
|
Flat JSON field names to extract from markdown. Use a comma-separated list or repeat the parameter, for example email,telephone. |
/urls
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
url |
required
|
Start URL for sitemap or link discovery. |
source |
optional
· auto
|
Discovery mode: auto, sitemap, or links. |
max_pages |
optional
· 250
|
Maximum page URLs to return. |
max_depth |
optional
· 2
|
Maximum link depth. When provided, Graze uses link traversal so depth is enforced. |
same_origin |
optional
· true
|
Restrict to same origin. |
include |
optional
|
Repeated regex filter for allowed URLs. |
exclude |
optional
|
Repeated regex filter for blocked URLs. |
/requests
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
limit |
optional
· 500
|
Maximum stored request records to return. |
/history/:id
| Parameter |
Type |
Description |
key |
required
|
API key for authentication. |
id |
required
|
Stored request id. |
App settings
