Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions api-reference/endpoint/activity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,12 @@ Lists your recent API activity from the last 24 hours. Use this to discover job
| `crawl` | `GET /v2/crawl/{id}` |
| `batch_scrape` | `GET /v2/batch/scrape/{id}` |
| `agent` | `GET /v2/agent/{jobId}` |

## Team Management Endpoints

| Operation | API path | Docs page |
|---|---|---|
| Team activity | `GET /v2/team/activity` | [`activity`](/api-reference/endpoint/activity) |
| Credit usage | `GET /v2/team/credit-usage` | [`credit-usage`](/api-reference/endpoint/credit-usage) |
| Credit usage (historical) | `GET /v2/team/credit-usage/historical` | [`credit-usage-historical`](/api-reference/endpoint/credit-usage-historical) |
| Queue status | `GET /v2/team/queue-status` | [`queue-status`](/api-reference/endpoint/queue-status) |
3 changes: 3 additions & 0 deletions api-reference/endpoint/token-usage-historical.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: 'Historical Token Usage'
openapi: '/api-reference/v2-openapi.json GET /team/token-usage/historical'
hidden: true
noindex: true

---

Returns historical token usage on a month-by-month basis. The endpoint can also breaks usage down by API key optionally.
Expand Down
3 changes: 3 additions & 0 deletions api-reference/endpoint/token-usage.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title: 'Token Usage'
openapi: '/api-reference/v2-openapi.json GET /team/token-usage'
hidden: true
noindex: true

---

<Info>We've simplified billing so that Extract now uses credits, just like all of the other endpoints. Each credit is worth 15 tokens. Reported token usage now includes usage from all endpoints.</Info>
Expand Down
60 changes: 60 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -4841,6 +4841,66 @@
]
},
"redirects": [
{
"destination": "/api-reference/endpoint/browser-create",
"source": "/api-reference/endpoint/browser-create-session"
},
{
"destination": "/api-reference/endpoint/browser-execute",
"source": "/api-reference/endpoint/browser-actions"
},
{
"destination": "/api-reference/endpoint/scrape-browser-delete",
"source": "/api-reference/endpoint/scrape-delete-interact"
},
{
"destination": "/api-reference/endpoint/crawl-params-preview",
"source": "/api-reference/endpoint/crawl-url-params-preview"
},
{
"destination": "/api-reference/endpoint/crawl-params-preview",
"source": "/api-reference/endpoint/crawl-url-preview"
},
{
"destination": "/api-reference/endpoint/crawl-active",
"source": "/api-reference/endpoint/crawl-get-active"
},
{
"destination": "/features/interact",
"source": "/features/scrape-and-interact"
},
{
"destination": "/api-reference/endpoint/token-usage",
"source": "/api-reference/endpoint/get-token-usage"
},
{
"destination": "/api-reference/endpoint/token-usage-historical",
"source": "/api-reference/endpoint/get-token-usage-historical"
},
{
"destination": "/api-reference/endpoint/activity",
"source": "/api-reference/endpoint/get-team-activity"
},
{
"destination": "/api-reference/endpoint/queue-status",
"source": "/api-reference/endpoint/get-team-queue-status"
},
{
"destination": "/api-reference/endpoint/credit-usage-historical",
"source": "/api-reference/endpoint/get-team-credit-usage-historical"
},
{
"destination": "/api-reference/endpoint/token-usage",
"source": "/api-reference/endpoint/team/get-token-usage"
},
{
"destination": "/api-reference/endpoint/token-usage-historical",
"source": "/api-reference/endpoint/team/get-token-usage-historical"
},
{
"destination": "/api-reference/endpoint/credit-usage-historical",
"source": "/api-reference/endpoint/team/get-credit-usage-historical"
},
{
"destination": "/mcp-server",
"source": "/mcp-server/connect"
Expand Down
10 changes: 5 additions & 5 deletions features/interact.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ Scrape a page to get clean data, then call `/interact` to start taking actions i

## Choose the right interaction model

| Need | Use | Canonical docs |
|---|---|---|
| Start a standalone browser session without scraping first | Browser Sandbox / standalone Interact session | [Browser Sandbox](/features/browser), [Create Browser Session](/api-reference/endpoint/browser-create), [Execute Browser Code](/api-reference/endpoint/browser-execute), [List Browser Sessions](/api-reference/endpoint/browser-list), [Delete Browser Session](/api-reference/endpoint/browser-delete) |
| Continue from a scrape result using `scrapeId` | Interact after scraping | [Execute Interact](/api-reference/endpoint/scrape-execute), [Stop Interact](/api-reference/endpoint/scrape-browser-delete) |
| Need | Use | Canonical docs | SDK methods (Node) |
|---|---|---|---|
| Start a standalone browser session without scraping first | Browser Sandbox / standalone Interact session | [Browser Sandbox](/features/browser), [Create Browser Session](/api-reference/endpoint/browser-create), [Execute Browser Code](/api-reference/endpoint/browser-execute), [List Browser Sessions](/api-reference/endpoint/browser-list), [Delete Browser Session](/api-reference/endpoint/browser-delete) | `browser()`, `browserExecute()`, `listBrowsers()`, `deleteBrowser()` |
| Continue from a scrape result using `scrapeId` | Interact after scraping | [Execute Interact](/api-reference/endpoint/scrape-execute), [Stop Interact](/api-reference/endpoint/scrape-browser-delete) | `interact()`, `stopInteraction()` |

Use scrape-bound Interact when the workflow begins with `POST /v2/scrape` and the response includes `data.metadata.scrapeId`. Use Browser Sandbox when you need a standalone session with its own lifecycle.
Use scrape-bound Interact when the workflow begins with `POST /v2/scrape` and the response includes `data.metadata.scrapeId`. Use Browser Sandbox when you need a standalone session with its own lifecycle. The Python SDK uses the snake_case equivalents (`browser()`, `browser_execute()`, `list_browsers()`, `delete_browser()`, `interact()`, `stop_interaction()`).

<CardGroup cols={3}>
<Card title="AI prompts" icon="wand-magic-sparkles">
Expand Down