{"openapi":"3.1.0","info":{"title":"National Cancer Institute (cancer.gov) API (Bowmark)","version":"e833508f87ff","description":"The US National Cancer Institute: PDQ cancer information, the clinical-trial register, cancer drugs, NCI-designated cancer centers and the cancer dictionaries. Callable now: the NCI-Designated Cancer Center directory (`findCancerCenters`) — every center's name, designation type, location and host institution, optionally filtered by state — and `getCancerInfoSummary` — NCI's own PDQ information summary for a cancer topic, patient or health-professional version, with its own revision date. The other eleven declared functions are still stubs.\n\nEvery function Bowmark has for National Cancer Institute (cancer.gov) (cancer.gov) as one HTTP call. Each runs on Bowmark's infrastructure with the same billing, rules and response envelope as `POST /v1/run`. The whole API: https://api.bowmark.ai/openapi.json. Guide: https://bowmark.ai/docs/api.","contact":{"email":"support@bowmark.ai","url":"https://bowmark.ai/docs/api"}},"servers":[{"url":"https://api.bowmark.ai"}],"security":[{"bearer":[]},{"apiKeyHeader":[]}],"paths":{"/v1/sites/cancer/findCancerCenters":{"post":{"operationId":"findCancerCenters","summary":"The NCI-Designated Cancer Centers — the institutions NCI itself certifies as meeting its standards for cancer research and care — each with its name, its designation type (Comprehensive, Clinical, or ","description":"The NCI-Designated Cancer Centers — the institutions NCI itself certifies as meeting its standards for cancer research and care — each with its name, its designation type (Comprehensive, Clinical, or Basic Laboratory), its city and state, its parent university or health system when it has one, and the link to its own cancer.gov detail page. `state` (NCI's own state name, e.g. \"California\", \"Hawai'i\", \"District of Columbia\", matched case-insensitively but exactly — no fuzzy matching) filters to that state; omitted, every center is returned. A center that operates comprehensive facilities in more than one state (Mayo Clinic Cancer Center) is cross-listed under each, with `locationNote` naming its other locations. This is the whole directory in one document — NCI does not filter it server-side — so `total` and `centers.length` are always equal.\n\nCalls `bowmark.providers.cancer.findCancerCenters`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<cancerCentersResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"state":{"type":"string"}},"additionalProperties":true,"description":"TypeScript: `{ state?: string }`"}},"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}},"/v1/sites/cancer/getCancerInfoSummary":{"post":{"operationId":"getCancerInfoSummary","summary":"NCI's own PDQ information summary for one cancer topic — what the cancer is, its symptoms and risk factors, how it is diagnosed and staged, the treatment options by stage, and the prognosis — split in","description":"NCI's own PDQ information summary for one cancer topic — what the cancer is, its symptoms and risk factors, how it is diagnosed and staged, the treatment options by stage, and the prognosis — split into the site's own headed sections, each with its heading and text. `topic` is cancer.gov's own `/types` path segment (e.g. \"breast\", \"lung\", \"prostate\"). `audience` (default `\"patient\"`) selects the patient-facing version or the more technical health-professional one NCI maintains separately; both carry the same `document-dates` revision block when the topic publishes one. `revisionDate` (ISO 8601) is the PDQ Editorial Board's own \"Updated\" date for the exact document returned — PDQ is continuously revised, so this is not decoration. English only: the Spanish path for the same topic uses different words, not a parameter substitution on the English slug (breast's HP Spanish page is `/espanol/tipos/seno/pro/tratamiento-seno-pdq`, not a `breast`/`hp` swap), and reaching it needs its own resolver over the Spanish `/espanol/tipos` index — unbuilt. Two ways this throws instead of guessing: `CancerInfoSummaryNotPublishedError` when the topic+audience has no single consolidated document (NCI is mid-redesign — breast's patient content was migrated to a task-based hub with no one document or date; its health-professional content is unaffected), and `CancerInfoSummaryAmbiguousTopicError` when the topic's own index entry covers more than one genuinely distinct disease, each with its own summary (lung: non-small-cell and small-cell are both filed under `/types/lung`) — the error names every option's own URL rather than silently answering for the wrong one.\n\nCalls `bowmark.providers.cancer.getCancerInfoSummary`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<cancerInfoSummaryResult>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"topic":{"type":"string"},"audience":{"anyOf":[{"const":"patient"},{"const":"healthProfessional"}]}},"required":["topic"],"additionalProperties":true,"description":"TypeScript: `{ topic: string; audience?: \"patient\" | \"healthProfessional\" }`"}},"required":["args"],"additionalProperties":false}}}},"responses":{"200":{"description":"The call ran. That includes a call that failed (`status: error`) or paused for a sign-in (`status: needs_user`), so branch on `status`.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/RunEnvelope"},{"type":"object","properties":{"result":{}}}]}}}},"400":{"description":"The body was malformed. `error` says what to send.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"401":{"description":"No API key, or a key that was refused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"402":{"description":"The account is out of free usage, at its spend cap, or its card was declined. Fix billing at https://bowmark.ai/dashboard/billing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"404":{"$ref":"#/components/responses/NotFound"},"429":{"description":"Too many runs in flight on this account. Nothing was started or charged.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}},"headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}}},"503":{"description":"A failure on Bowmark's side. Retry.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}}}}},"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Your Bowmark API key."},"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-Bowmark-Key"}},"responses":{"NotFound":{"description":"No such site or function.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}}},"schemas":{"RunEnvelope":{"type":"object","description":"What a run returns. `status` says whether the SCRIPT succeeded. A script that threw or paused for a login is still HTTP 200. Branch on `status`, not on the HTTP code.","required":["ok","status","result","logs","error","ms"],"properties":{"runId":{"type":"string","description":"Stable id for this run. Quote it in a support or `report` message."},"ok":{"type":"boolean","description":"False only when the run produced nothing usable."},"status":{"type":"string","enum":["ok","error","partial","needs_user"],"description":"`partial`: the result is real but some calls failed (see `incomplete`); `ok` stays true. `needs_user`: a person must sign in to a site first. Relay `meta.handoff.url` to them, then run again."},"egress":{"type":"string","enum":["default","link"],"description":"The egress the run was given, present only when the request asked for one. `link`: every request went through the caller's own Chrome (Bowmark Buddy)."},"result":{"description":"Whatever the script `return`ed. Any JSON value."},"logs":{"type":"array","items":{"type":"string"},"description":"Lines the script wrote with `log(...)`."},"error":{"type":["string","null"],"description":"Why the run failed, in plain words. Null on success."},"ms":{"type":"integer","description":"How long the script itself ran, in milliseconds."},"queuedMs":{"type":"integer","description":"How long the run waited for a worker before starting. Present only when it was a second or more."},"needs":{"type":"array","description":"The sign-ins this script is waiting on. Present when `status` is `needs_user`.","items":{"type":"object","required":["capability","provider","providerTitle","kind"],"properties":{"capability":{"type":"string"},"provider":{"type":"string"},"providerTitle":{"type":"string","description":"The site's name, to show a person."},"kind":{"type":"string"}}}},"incomplete":{"type":"object","description":"Present only when `status` is `partial`: which calls did not answer.","properties":{"summary":{"type":"string"},"totalCalls":{"type":"integer"}},"additionalProperties":true},"emptyHanded":{"type":"object","description":"Present when the script returned nothing while its calls returned rows, usually a filter that matched none of the site's own labels. Lists the label values the calls actually returned.","additionalProperties":true},"notes":{"type":"array","description":"Caveats a call attached to a complete answer. Never changes `status`.","items":{"type":"object","properties":{"path":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"meta":{"type":"object","properties":{"handoff":{"type":"object","description":"A single-use sign-in link for a person to open. Expires at `expiresAt`.","properties":{"ref":{"type":"string"},"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time"}}},"concurrency":{"type":"object","description":"On a 429: how many runs are in flight and when to retry.","properties":{"limit":{"type":"integer"},"inFlight":{"type":"integer"},"retryAfterSeconds":{"type":"integer"}}}},"additionalProperties":true},"notice":{"type":"object","description":"Set when the account owner has not accepted the current Terms. Relay it to them.","additionalProperties":true}}}}}}