ScrapeGraphAI
DEVELOPER · DEVELOPER
Scrapes, LLM-driven structured extraction, and search run on their own key.
Acts as the person, not as itself
Each user connects their own account. Every call carries both identities — the agent and the person it is acting for — so the agent can never reach past what that individual can already do.
Credentials never touch the agent
Tokens live in the vault and attach server-side at call time. The agent holds a session, not a secret, and revoking access does not mean rotating a key.
Every call on the record
Who asked, which agent acted, which action ran, and the verdict that let it through — one audit trail across every integration, not one per vendor.
What an agent can do
Each action is granted on its own. An agent allowed to read is not thereby allowed to write, and the scope beside each row is what the acting user must have connected for it to run at all.
scrapegraphai_delete_api_agent_subscriptionWRITECancel your agent subscription. DELETE /api/agent/subscription. Requires SGAI-APIKEY. Stops future Inflow billing immediately. Paid access and subscription credits remain until paidThrough; top-ups and the API key do not expire with the subscription. Idempotent; no automatic refund.
scrapegraphai_delete_api_crawl_by_idWRITEDelete a crawl. DELETE /api/crawl/{id}.
scrapegraphai_delete_api_monitor_by_idWRITEDelete a monitor. DELETE /api/monitor/{id}.
scrapegraphai_getREADService card. GET /. Where to find the docs, OpenAPI, and agent discovery documents.
scrapegraphai_get_api_agent_odp_collectionsREADList offering collections. GET /api/agent/odp/collections. Requires Accept: application/odp+json. Uses the ODP 1.0 response format.
scrapegraphai_get_api_agent_odp_collections_by_idREADGet a collection. GET /api/agent/odp/collections/{id}. Requires Accept: application/odp+json. Uses the ODP 1.0 response format.
scrapegraphai_get_api_agent_odp_collections_by_id_offeringsREADList offerings in a collection. GET /api/agent/odp/collections/{id}/offerings. Requires Accept: application/odp+json. Uses the ODP 1.0 response format.
scrapegraphai_get_api_agent_odp_offeringsREADList credit packs and subscriptions. GET /api/agent/odp/offerings. Requires Accept: application/odp+json. Uses the ODP 1.0 response format.
scrapegraphai_get_api_agent_odp_offerings_by_idREADGet an offering. GET /api/agent/odp/offerings/{id}. Requires Accept: application/odp+json. Uses the ODP 1.0 response format.
scrapegraphai_get_api_agent_odp_schemas_subscription_jsonREADGet the subscription attribute schema. GET /api/agent/odp/schemas/subscription.json.
scrapegraphai_get_api_agent_protocolsREADDiscover agent payments, credit packs, and subscriptions. GET /api/agent/protocols. Free, unauthenticated discovery: which payment protocols this API accepts, the credit packs and monthly/yearly subscriptions on sale, and the endpoints a keyless agent uses to buy access.
scrapegraphai_get_api_agent_subscriptionREADGet your agent subscription. GET /api/agent/subscription. Requires SGAI-APIKEY. Returns Inflow status, paid-through date, and remaining subscription and top-up credits.
scrapegraphai_get_api_crawl_by_idREADGet crawl status and pages. GET /api/crawl/{id}.
scrapegraphai_get_api_crawl_by_id_pagesREADGet paginated crawl pages. GET /api/crawl/{id}/pages.
scrapegraphai_get_api_creditsREADGet credits balance. GET /api/credits. Returns remaining credits, usage, plan, and job slot usage.
scrapegraphai_get_api_healthREADHealth check. GET /api/health. Returns ok if Redis and DB are reachable, degraded otherwise.
scrapegraphai_get_api_historyREADList request history. GET /api/history. Session ID filters use case-insensitive partial matching.
scrapegraphai_get_api_history_by_idREADGet a history entry. GET /api/history/{id}.
scrapegraphai_get_api_monitorREADList monitors. GET /api/monitor.
scrapegraphai_get_api_monitor_by_idREADGet a monitor. GET /api/monitor/{id}.
scrapegraphai_get_api_monitor_by_id_activityREADGet monitor tick activity. GET /api/monitor/{id}/activity.
scrapegraphai_get_api_validateREADValidate API key. GET /api/validate. Returns the email of the user owning the provided API key.
scrapegraphai_get_well_known_aepREADAEP inspect document. GET /.well-known/aep. Agent enrollment entrypoint: identity methods, grant types, and command URLs.
scrapegraphai_get_well_known_did_jsonREADService DID document. GET /.well-known/did.json. The did:web document for did:web:sgai-api-v2.onrender.com. Carries no keys; agents check it matches the origin.
scrapegraphai_get_well_known_odpREADGet the ODP service document. GET /.well-known/odp. Requires Accept: application/odp+json. Uses the ODP 1.0 response format.
scrapegraphai_patch_api_monitor_by_idWRITEUpdate a monitor. PATCH /api/monitor/{id}.
scrapegraphai_post_api_crawlWRITEStart a crawl. POST /api/crawl.
scrapegraphai_post_api_crawl_by_id_resumeWRITEResume a paused crawl. POST /api/crawl/{id}/resume.
scrapegraphai_post_api_crawl_by_id_stopWRITEStop a running crawl. POST /api/crawl/{id}/stop.
scrapegraphai_post_api_credits_purchase_by_packWRITEBuy a credit pack with USDC. SPENDS THE CONNECTED ACCOUNT'S MONEY: this BUYS a credit pack, paid in USDC over the Machine Payments Protocol, and adds the credits to the account this connection holds the key for. It is not a quote and not a dry run -- there is no preview form of this call. It cannot complete on an API key alone: an unpaid request answers 402 with a 'WWW-Authenticate: Payment' challenge that only a funded MPP wallet can settle, and this connection holds no wallet credential, so a 402 here is the EXPECTED outcome rather than a failure to retry. Never call it again on a 402, and never call it speculatively: repeated payment is repeated spending. Read the balance first with Get credits balance, which is free. POST /api/credits/purchase/{pack}. Purchase a credit pack by paying USDC over the Machine Payments Protocol (MPP). An unpaid request returns 402 with a WWW-Authenticate: Payment challenge; pay it and retry with Authorization: Payment <credential> to receive credits and a Payment-Receipt header.
scrapegraphai_post_api_extractWRITEExtract structured JSON. POST /api/extract. LLM-driven extraction from a URL, HTML, or markdown input with a prompt+schema.
scrapegraphai_post_api_monitorWRITECreate a monitor. POST /api/monitor.
scrapegraphai_post_api_monitor_by_id_pauseWRITEPause a monitor. POST /api/monitor/{id}/pause.
scrapegraphai_post_api_monitor_by_id_resumeWRITEResume a monitor. POST /api/monitor/{id}/resume.
scrapegraphai_post_api_scrapeWRITEScrape a URL. POST /api/scrape. Fetches a URL and returns the requested format(s): markdown, html, links, images, summary, json, branding, screenshot.
scrapegraphai_post_api_searchWRITESearch + scrape top results. POST /api/search. Runs a search, scrapes the top N result URLs, optionally runs LLM extraction with prompt+schema.
Often connected alongside
Put ScrapeGraphAI behind one governed endpoint.
Same permissions, same audit trail, whatever else you connect next.