docs(integrations): add Orthogonal page under Frameworks#79
Open
ChristianPickettCode wants to merge 4 commits intoScrapeGraphAI:mainfrom
Open
docs(integrations): add Orthogonal page under Frameworks#79ChristianPickettCode wants to merge 4 commits intoScrapeGraphAI:mainfrom
ChristianPickettCode wants to merge 4 commits intoScrapeGraphAI:mainfrom
Conversation
Adds a Frameworks integration page documenting how to call ScrapeGraph v2 endpoints through the Orthogonal API gateway, covering the @orth/sdk TypeScript SDK, the orth CLI, the MCP server, and x402 stablecoin payments. Cross-links to the existing /integrations/x402 page rather than duplicating the payment-protocol reference. Registers integrations/orthogonal under the Frameworks group in docs.json next to llamaindex, langchain, langgraph, crewai, and agno.
Self-review against docs.orthogonal.com surfaced four inaccuracies in the initial draft. This commit fixes them: - CLI auth uses ORTHOGONAL_API_KEY env var or --key flag; there is no `orth login` subcommand. Replaced with the env-var export shown in the official CLI doc. - MCP server is hosted at https://mcp.orth.sh and registered via the client's mcpServers config — there is no `npx @orth/mcp install`. Updated the example to show the JSON config block. - The MCP server exposes four tools — search, get_details, integrate, use — not search_apis/run_api/get_code/list_apis (those are the Agent Platforms HTTP tool names). Corrected the names and the example-call tool from `run_api` to `use`. - Removed the unverified "(6 endpoints)" annotation in the CLI search output. The catalog count drifts and the docs themselves show "(3 endpoints)" — the page now points readers at `orth api scrapegraph` for the live count. Also tightens the SDK constructor (explicit apiKey rather than implying auto-env-load), expands the CLI section to show endpoint-detail lookup (`orth api scrapegraph /v1/smartscraper`), and adds priceCents + HTTP-402 detail to the failure-envelope example to match the format documented at docs.orthogonal.com/api-reference/run.
Verified against the @orth/cli source (cli/src/commands/auth.ts): `orth login` is a real, browser-based OAuth-style command — it opens the dashboard, captures the returned key on a localhost callback, and persists it. The earlier "fix" that removed it was based on a stale docs page that only documented the env-var path. This commit shows both options: `orth login` (recommended, no manual key copy-paste) and the explicit `ORTHOGONAL_API_KEY` env var.
…ns/x402 Removes the three cross-links to the existing x402 integration page so this page stands alone. Folds the missing pieces inline: a brief description of the HTTP 402 flow, a Python (CodeGroup) example next to the Node.js one, and the install lines for both x402-fetch + viem and x402 + eth-account. External references (x402.org, github.com/coinbase/x402) replace the internal /integrations/x402 link.
VinciGit00
requested changes
May 9, 2026
Member
VinciGit00
left a comment
VinciGit00
left a comment
There was a problem hiding this comment.
you can use your logo instead of the orange pattern
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new Frameworks integration page —
integrations/orthogonal.mdx— documenting how to call ScrapeGraph v2 endpoints through the Orthogonal API gateway.The page covers the four ways an agent can reach ScrapeGraph through Orthogonal:
@orth/sdk— TypeScript SDK wrappingPOST /v1/run. OneORTHOGONAL_API_KEYis enough; no separateSGAI_API_KEYrequired.orthCLI — for one-off scrapes and shell pipelines, with browser-basedorth loginor env-var auth.https://mcp.orth.sh, registered via the client'smcpServersconfig; exposessearch,get_details,use, andintegratetools.It also documents Orthogonal's
search/details/integratediscovery endpoints (which return ScrapeGraph parameter schemas at runtime) and the unified{ success, priceCents, data, requestId }response envelope.Registers the new page under the Frameworks group in
docs.jsonnext to llamaindex, langchain, langgraph, crewai, and agno.Test plan
/integrations/orthogonalunder the Frameworks group/api-reference/introduction,/sdks/python<CodeGroup>for the x402 Node.js / Python pair renders as tabsHappy to iterate on tone, ordering, or the title emoji (currently 🟧 — open to swapping it for whatever the ScrapeGraph team prefers).