{"openapi":"3.1.0","info":{"title":"Oncrawl (BYOK) API","version":"0.1.0","description":"Oncrawl (BYOK) lets an AI assistant read your own Oncrawl data through the Oncrawl API with a key you supply (Oncrawl access token (projects:read scope)). Read-only: 9 tools (list_workspaces, get_workspace, list_projects, get_project, list_crawls, get_crawl, get_crawl_progress, list_scheduled_crawls, list_crawl_over_crawls). The BYOK key travels with each request, is used for that one call only...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-oncrawl.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-oncrawl/docs"},"termsOfService":"https://connectorbay.com/byok-oncrawl/terms"},"servers":[{"url":"https://byok-oncrawl.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-oncrawl/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_workspaces":{"post":{"operationId":"list_workspaces","summary":"List the Oncrawl workspaces the token can access, with the user's role and subscription status. Use for \"Which Oncrawl w","description":"List the Oncrawl workspaces the token can access, with the user's role and subscription status. Use for \"Which Oncrawl workspaces do I have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (default 10, up to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip (default 0).","title":"Offset"}},"title":"list_workspacesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_workspace":{"post":{"operationId":"get_workspace","summary":"Get one workspace: name, your role, enabled subscription features and subscription status. Use for \"Is my Oncrawl worksp","description":"Get one workspace: name, your role, enabled subscription features and subscription status. Use for \"Is my Oncrawl workspace subscription active\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Oncrawl workspace id, from list_workspaces.","maxLength":60,"title":"Workspace Id","type":"string"}},"required":["workspace_id"],"title":"get_workspaceArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_projects":{"post":{"operationId":"list_projects","summary":"List the SEO projects (one per site) of a workspace with start URL, domain, enabled features and latest crawl id. Use fo","description":"List the SEO projects (one per site) of a workspace with start URL, domain, enabled features and latest crawl id. Use for \"Which sites do I crawl in Oncrawl\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Oncrawl workspace id, from list_workspaces.","maxLength":60,"title":"Workspace Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (default 10, up to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip (default 0).","title":"Offset"}},"required":["workspace_id"],"title":"list_projectsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_project":{"post":{"operationId":"get_project","summary":"Get one project: start URL, domain, verification method, features, log monitoring flags and the ids of its crawls and cr","description":"Get one project: start URL, domain, verification method, features, log monitoring flags and the ids of its crawls and crawl configurations. Use for \"What crawls does the Oncrawl project 592c1e1cf2c3a42743d14350 have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Oncrawl project id, from list_projects.","maxLength":60,"title":"Project Id","type":"string"}},"required":["project_id"],"title":"get_projectArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_crawls":{"post":{"operationId":"list_crawls","summary":"List the crawls of a workspace, newest first, with status, start and end time, number of fetched URLs and end reason. Us","description":"List the crawls of a workspace, newest first, with status, start and end time, number of fetched URLs and end reason. Use for \"What were my latest Oncrawl crawls and did they finish\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Oncrawl workspace id, from list_workspaces.","maxLength":60,"title":"Workspace Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (default 10, up to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip (default 0).","title":"Offset"}},"required":["workspace_id"],"title":"list_crawlsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_crawl":{"post":{"operationId":"get_crawl","summary":"Get one crawl: status, timing, fetched URL count, depth, end reason, features and the crawl configuration used. Use for ","description":"Get one crawl: status, timing, fetched URL count, depth, end reason, features and the crawl configuration used. Use for \"How many URLs did Oncrawl crawl 5abceb9303d27a70f93151cb fetch\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"crawl_id":{"description":"Oncrawl crawl id, from list_crawls or get_project.","maxLength":60,"title":"Crawl Id","type":"string"}},"required":["crawl_id"],"title":"get_crawlArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_crawl_progress":{"post":{"operationId":"get_crawl_progress","summary":"Follow a running crawl: status, fetched URL counts by HTTP class, queued URLs, current depth and processing steps. Use f","description":"Follow a running crawl: status, fetched URL counts by HTTP class, queued URLs, current depth and processing steps. Use for \"How far along is Oncrawl crawl 5abceb9303d27a70f93151cb\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"crawl_id":{"description":"Oncrawl crawl id, from list_crawls or get_project.","maxLength":60,"title":"Crawl Id","type":"string"}},"required":["crawl_id"],"title":"get_crawl_progressArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_scheduled_crawls":{"post":{"operationId":"list_scheduled_crawls","summary":"List the recurring crawls scheduled for a project with configuration id, recurrence and first start time. Use for \"When ","description":"List the recurring crawls scheduled for a project with configuration id, recurrence and first start time. Use for \"When does Oncrawl crawl project 592c1e1cf2c3a42743d14350 automatically\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"project_id":{"description":"Oncrawl project id, from list_projects.","maxLength":60,"title":"Project Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (default 10, up to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip (default 0).","title":"Offset"}},"required":["project_id"],"title":"list_scheduled_crawlsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_crawl_over_crawls":{"post":{"operationId":"list_crawl_over_crawls","summary":"List the crawl-over-crawl comparisons of a workspace with status and the two crawls compared. Use for \"Which Oncrawl cra","description":"List the crawl-over-crawl comparisons of a workspace with status and the two crawls compared. Use for \"Which Oncrawl crawl comparisons have I run\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace_id":{"description":"Oncrawl workspace id, from list_workspaces.","maxLength":60,"title":"Workspace Id","type":"string"},"limit":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (default 10, up to 100).","title":"Limit"},"offset":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"How many results to skip (default 0).","title":"Offset"}},"required":["workspace_id"],"title":"list_crawl_over_crawlsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}