{"openapi":"3.1.0","info":{"title":"National Hurricane Center API (Bowmark)","version":"e833508f87ff","description":"Current and recent tropical storms and hurricanes from NOAA's Hurricane Center, keyless and public.\n\nEvery function Bowmark has for National Hurricane Center (nhc.noaa.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/nhc/listCurrentStorms":{"post":{"operationId":"listCurrentStorms","summary":"List every active tropical storm and hurricane across the Atlantic, East Pacific and Central Pacific, with position, intensity and pressure.","description":"List every active tropical storm and hurricane across the Atlantic, East Pacific and Central Pacific, with position, intensity and pressure. Pass `basin` to narrow to one of them.\n\nCalls `bowmark.providers.nhc.listCurrentStorms`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcCurrentStorm[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"basin":{"anyOf":[{"const":"AL"},{"const":"EP"},{"const":"CP"}]}},"additionalProperties":true,"description":"TypeScript: `{ basin?: 'AL' | 'EP' | 'CP' }`"}},"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/nhc/getStormInfo":{"post":{"operationId":"getStormInfo","summary":"Get one active storm's current status — position, intensity, pressure, movement, classification and links to its latest advisory products — by the id returned from listCurrentStorms.","description":"Get one active storm's current status — position, intensity, pressure, movement, classification and links to its latest advisory products — by the id returned from listCurrentStorms.\n\nCalls `bowmark.providers.nhc.getStormInfo`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcStormInfo>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"stormId":{"type":"string"}},"required":["stormId"],"additionalProperties":true,"description":"TypeScript: `{ stormId: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getStormAdvisory":{"post":{"operationId":"getStormAdvisory","summary":"Get a storm's public advisory text — headline, location, wind/pressure data, watches and warnings, and hazards information.","description":"Get a storm's public advisory text — headline, location, wind/pressure data, watches and warnings, and hazards information.\n\nCalls `bowmark.providers.nhc.getStormAdvisory`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcAdvisory>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"advisoryUrl":{"type":"string"}},"required":["advisoryUrl"],"additionalProperties":true,"description":"TypeScript: `{ advisoryUrl: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getStormForecast":{"post":{"operationId":"getStormForecast","summary":"Get a storm's forecast advisory — forecast positions out to 5 days, maximum sustained winds, and wind radii projections.","description":"Get a storm's forecast advisory — forecast positions out to 5 days, maximum sustained winds, and wind radii projections.\n\nCalls `bowmark.providers.nhc.getStormForecast`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcForecastAdvisory>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"forecastUrl":{"type":"string"}},"required":["forecastUrl"],"additionalProperties":true,"description":"TypeScript: `{ forecastUrl: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getWatchesWarnings":{"post":{"operationId":"getWatchesWarnings","summary":"Get the watches and warnings in effect for a storm from its public advisory — separated into watch and warning categories with locations.","description":"Get the watches and warnings in effect for a storm from its public advisory — separated into watch and warning categories with locations.\n\nCalls `bowmark.providers.nhc.getWatchesWarnings`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcWatchesWarnings>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"advisoryUrl":{"type":"string"}},"required":["advisoryUrl"],"additionalProperties":true,"description":"TypeScript: `{ advisoryUrl: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getTropicalOutlook":{"post":{"operationId":"getTropicalOutlook","summary":"Get the Tropical Weather Outlook for a basin: each disturbance being watched, where it is, and its 2-day and 7-day formation chance.","description":"Get the Tropical Weather Outlook for a basin: each disturbance being watched, where it is, and its 2-day and 7-day formation chance.\n\nCalls `bowmark.providers.nhc.getTropicalOutlook`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcTropicalOutlook>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"basin":{"anyOf":[{"const":"AL"},{"const":"EP"},{"const":"CP"}]}},"required":["basin"],"additionalProperties":true,"description":"TypeScript: `{ basin: 'AL' | 'EP' | 'CP' }`"}},"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"}}}}}}},"/v1/sites/nhc/listSeasonStorms":{"post":{"operationId":"listSeasonStorms","summary":"List every storm of one hurricane season in a basin, with id, name and classification.","description":"List every storm of one hurricane season in a basin, with id, name and classification. The archive covers 1998 onward.\n\nCalls `bowmark.providers.nhc.listSeasonStorms`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcSeasonStorm[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"year":{"type":"number"},"basin":{"anyOf":[{"const":"AL"},{"const":"EP"},{"const":"CP"}]}},"required":["year"],"additionalProperties":true,"description":"TypeScript: `{ year: number, basin?: 'AL' | 'EP' | 'CP' }`"}},"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"}}}}}}},"/v1/sites/nhc/searchStorms":{"post":{"operationId":"searchStorms","summary":"Find a storm by name.","description":"Find a storm by name. With no `year`, matches a currently active storm. With `year`, searches that season's archive (1998 onward) and returns every match — a name can recur across basins or seasons.\n\nCalls `bowmark.providers.nhc.searchStorms`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcSeasonStorm[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"name":{"type":"string"},"year":{"type":"number"},"basin":{"anyOf":[{"const":"AL"},{"const":"EP"},{"const":"CP"}]}},"required":["name"],"additionalProperties":true,"description":"TypeScript: `{ name: string, year?: number, basin?: 'AL' | 'EP' | 'CP' }`"}},"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"}}}}}}},"/v1/sites/nhc/listStormAdvisories":{"post":{"operationId":"listStormAdvisories","summary":"List every forecast advisory, public advisory, discussion and wind probability product a storm has issued, with product type, sequence number, issue time and url.","description":"List every forecast advisory, public advisory, discussion and wind probability product a storm has issued, with product type, sequence number, issue time and url. Feeds the advisory/forecast/discussion urls other functions take.\n\nCalls `bowmark.providers.nhc.listStormAdvisories`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcAdvisoryProduct[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"stormId":{"type":"string"}},"required":["stormId"],"additionalProperties":true,"description":"TypeScript: `{ stormId: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getForecastDiscussion":{"post":{"operationId":"getForecastDiscussion","summary":"Get the forecaster's discussion for a storm — the reasoning behind the track and intensity forecast — from a discussion url (from listStormAdvisories or listCurrentStorms' `links.forecastDiscussion`).","description":"Get the forecaster's discussion for a storm — the reasoning behind the track and intensity forecast — from a discussion url (from listStormAdvisories or listCurrentStorms' `links.forecastDiscussion`).\n\nCalls `bowmark.providers.nhc.getForecastDiscussion`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcForecastDiscussion>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"discussionUrl":{"type":"string"}},"required":["discussionUrl"],"additionalProperties":true,"description":"TypeScript: `{ discussionUrl: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getWindSpeedProbabilities":{"post":{"operationId":"getWindSpeedProbabilities","summary":"Get a storm's wind speed probabilities: for each listed town, the chance of 34, 50 and 64 kt sustained winds per time period and over 5 days.","description":"Get a storm's wind speed probabilities: for each listed town, the chance of 34, 50 and 64 kt sustained winds per time period and over 5 days. Takes a wndprb product url from listStormAdvisories() or listCurrentStorms' `links.windSpeedProbabilities`.\n\nCalls `bowmark.providers.nhc.getWindSpeedProbabilities`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcWindSpeedProbabilities>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"productUrl":{"type":"string"}},"required":["productUrl"],"additionalProperties":true,"description":"TypeScript: `{ productUrl: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getTropicalWeatherDiscussion":{"post":{"operationId":"getTropicalWeatherDiscussion","summary":"Get the latest basin-wide Tropical Weather Discussion for the Atlantic or East Pacific — special features, tropical waves, the monsoon trough and marine weather, split by section.","description":"Get the latest basin-wide Tropical Weather Discussion for the Atlantic or East Pacific — special features, tropical waves, the monsoon trough and marine weather, split by section.\n\nCalls `bowmark.providers.nhc.getTropicalWeatherDiscussion`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcTropicalWeatherDiscussion>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"basin":{"anyOf":[{"const":"AL"},{"const":"EP"}]}},"required":["basin"],"additionalProperties":true,"description":"TypeScript: `{ basin: 'AL' | 'EP' }`"}},"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"}}}}}}},"/v1/sites/nhc/getStormNames":{"post":{"operationId":"getStormNames","summary":"Get the official storm name lists: the six rotating Atlantic and East Pacific season lists and the four Central Pacific lists.","description":"Get the official storm name lists: the six rotating Atlantic and East Pacific season lists and the four Central Pacific lists. Pass `basin` to narrow.\n\nCalls `bowmark.providers.nhc.getStormNames`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcStormNameList[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"basin":{"anyOf":[{"const":"AL"},{"const":"EP"},{"const":"CP"}]}},"additionalProperties":true,"description":"TypeScript: `{ basin?: 'AL' | 'EP' | 'CP' }`"}},"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/nhc/getForecastCone":{"post":{"operationId":"getForecastCone","summary":"Get an active storm's forecast cone of uncertainty and forecast track as coordinates: the cone outline, the 5-day track line, and each forecast position with its time and expected winds.","description":"Get an active storm's forecast cone of uncertainty and forecast track as coordinates: the cone outline, the 5-day track line, and each forecast position with its time and expected winds.\n\nCalls `bowmark.providers.nhc.getForecastCone`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcForecastCone>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"stormId":{"type":"string"}},"required":["stormId"],"additionalProperties":true,"description":"TypeScript: `{ stormId: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getStormGraphics":{"post":{"operationId":"getStormGraphics","summary":"List an active storm's official graphics — the warnings and 5-day cone, wind field, wind speed probabilities, arrival times, key messages, rainfall — as full-size and thumbnail image URLs.","description":"List an active storm's official graphics — the warnings and 5-day cone, wind field, wind speed probabilities, arrival times, key messages, rainfall — as full-size and thumbnail image URLs.\n\nCalls `bowmark.providers.nhc.getStormGraphics`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcStormGraphic[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"stormId":{"type":"string"}},"required":["stormId"],"additionalProperties":true,"description":"TypeScript: `{ stormId: string }`"}},"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"}}}}}}},"/v1/sites/nhc/listMarineZones":{"post":{"operationId":"listMarineZones","summary":"List every offshore waters zone and high seas area NHC forecasts — Caribbean, Gulf of America, SW Atlantic, East Pacific — with the product code to pass to getMarineForecast.","description":"List every offshore waters zone and high seas area NHC forecasts — Caribbean, Gulf of America, SW Atlantic, East Pacific — with the product code to pass to getMarineForecast.\n\nCalls `bowmark.providers.nhc.listMarineZones`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcMarineZone[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{},"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/nhc/getMarineForecast":{"post":{"operationId":"getMarineForecast","summary":"Get NHC's offshore waters or high seas marine forecast: winds and seas by period for each zone.","description":"Get NHC's offshore waters or high seas marine forecast: winds and seas by period for each zone. Pass `zone` to get one zone.\n\nCalls `bowmark.providers.nhc.getMarineForecast`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcMarineForecast>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"product":{"anyOf":[{"const":"OFFNT3"},{"const":"OFFNT4"},{"const":"OFFNT5"},{"const":"OFFPZ7"},{"const":"OFFPZ8"},{"const":"HSFAT2"},{"const":"HSFEP2"}]},"zone":{"type":"string"}},"required":["product"],"additionalProperties":true,"description":"TypeScript: `{ product: 'OFFNT3' | 'OFFNT4' | 'OFFNT5' | 'OFFPZ7' | 'OFFPZ8' | 'HSFAT2' | 'HSFEP2'; zone?: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getBestTrack":{"post":{"operationId":"getBestTrack","summary":"Get a FILED storm's best track from HURDAT2 — its position, max winds, pressure and status every six hours (synoptic, plus NHC's own special points) over its whole life.","description":"Get a FILED storm's best track from HURDAT2 — its position, max winds, pressure and status every six hours (synoptic, plus NHC's own special points) over its whole life. Covers the Atlantic from 1851 and the East/Central Pacific from 1949, once the season has closed and the archive is updated.\n\nCalls `bowmark.providers.nhc.getBestTrack`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcBestTrackPoint[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"stormId":{"type":"string"}},"required":["stormId"],"additionalProperties":true,"description":"TypeScript: `{ stormId: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getTropicalCycloneReport":{"post":{"operationId":"getTropicalCycloneReport","summary":"Get the url of NHC's post-season Tropical Cyclone Report PDF for a FILED storm — the final meteorological history, casualties and damage.","description":"Get the url of NHC's post-season Tropical Cyclone Report PDF for a FILED storm — the final meteorological history, casualties and damage. Indexed by id from 1995 on; not published until the season closes.\n\nCalls `bowmark.providers.nhc.getTropicalCycloneReport`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcTropicalCycloneReport>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"stormId":{"type":"string"}},"required":["stormId"],"additionalProperties":true,"description":"TypeScript: `{ stormId: string }`"}},"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"}}}}}}},"/v1/sites/nhc/getSatelliteImagery":{"post":{"operationId":"getSatelliteImagery","summary":"Get the latest GOES satellite image links for a basin — GeoColor, Visible, Shortwave-IR, IR and Water Vapor, per sector, each with a still image, a loop and an animated GIF.","description":"Get the latest GOES satellite image links for a basin — GeoColor, Visible, Shortwave-IR, IR and Water Vapor, per sector, each with a still image, a loop and an animated GIF. `AL` returns the Atlantic sectors; `EP`/`CP` return the Pacific sectors.\n\nCalls `bowmark.providers.nhc.getSatelliteImagery`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcSatelliteImage[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"basin":{"anyOf":[{"const":"AL"},{"const":"EP"},{"const":"CP"}]}},"additionalProperties":true,"description":"TypeScript: `{ basin?: 'AL' | 'EP' | 'CP' }`"}},"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/nhc/getReconObservations":{"post":{"operationId":"getReconObservations","summary":"Get the latest Hurricane Hunter aircraft reconnaissance reports for the Atlantic (AL) or East Pacific (EP) basin: vortex data messages, flight-level (HDOB) observations and dropsonde soundings.","description":"Get the latest Hurricane Hunter aircraft reconnaissance reports for the Atlantic (AL) or East Pacific (EP) basin: vortex data messages, flight-level (HDOB) observations and dropsonde soundings. NHC flies no Central Pacific missions.\n\nCalls `bowmark.providers.nhc.getReconObservations`. The body is the function's arguments, keyed by parameter name. `result` in the response is what it returns: `Promise<nhcReconObservation[]>`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"args":{"type":"object","properties":{"basin":{"anyOf":[{"const":"AL"},{"const":"EP"}]}},"required":["basin"],"additionalProperties":true,"description":"TypeScript: `{ basin: 'AL' | 'EP' }`"}},"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}}}}}}