{"openapi":"3.1.0","info":{"title":"ReliefWeb (BYOK) API","version":"0.1.0","description":"ReliefWeb (BYOK) lets an AI assistant read your own ReliefWeb data through the ReliefWeb API with a key you supply (pre-approved ReliefWeb appname). Read-only: 7 tools (search_reports, get_report, search_disasters, list_countries, search_jobs, search_training, search_sources). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-reliefweb.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-reliefweb/docs"},"termsOfService":"https://connectorbay.com/byok-reliefweb/terms"},"servers":[{"url":"https://byok-reliefweb.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-reliefweb/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/search_reports":{"post":{"operationId":"search_reports","summary":"Search ReliefWeb reports (situation updates, analysis, maps) by text and one filter, newest first by default. Use for \"F","description":"Search ReliefWeb reports (situation updates, analysis, maps) by text and one filter, newest first by default. Use for \"Find the latest ReliefWeb reports about flooding in Kenya\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search with optional field prefix, for example 'earthquake' or 'title:flood'.","title":"Query"},"filter_field":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Field to filter on, for example country, disaster_type, format, source, theme, status or date.created (see ReliefWeb field tables).","title":"Filter Field"},"filter_value":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Value the filter field must have, for example 'Kenya' (leave empty to test only that the field exists).","title":"Filter Value"},"preset":{"anyOf":[{"enum":["latest","minimal","analysis"],"type":"string"},{"type":"null"}],"default":"latest","description":"Preset: latest (newest first, published items), minimal (default filters) or analysis (includes archived disasters and expired jobs and training).","title":"Preset"},"profile":{"anyOf":[{"enum":["minimal","list","full"],"type":"string"},{"type":"null"}],"default":"list","description":"Fields returned per item: minimal (title or name only), list (compact listing fields) or full (all fields).","title":"Profile"},"limit":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (0 to 1000; 0 returns only the total count).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many items (for paging).","title":"Offset"}},"title":"search_reportsArguments","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_report":{"post":{"operationId":"get_report","summary":"Get one ReliefWeb report by its numeric id; use profile=full to read the full text, sources, countries and files. Use fo","description":"Get one ReliefWeb report by its numeric id; use profile=full to read the full text, sources, countries and files. Use for \"Show ReliefWeb report 1082221 in full\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"report_id":{"description":"Numeric ReliefWeb id, for example 1082221 (find ids with search_reports).","maxLength":12,"title":"Report Id","type":"string"},"profile":{"anyOf":[{"enum":["minimal","list","full"],"type":"string"},{"type":"null"}],"default":"list","description":"Fields returned per item: minimal (title or name only), list (compact listing fields) or full (all fields).","title":"Profile"}},"required":["report_id"],"title":"get_reportArguments","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/search_disasters":{"post":{"operationId":"search_disasters","summary":"Search ReliefWeb disasters (events with GLIDE number, type, countries and status) by text and one filter. Use for \"Which","description":"Search ReliefWeb disasters (events with GLIDE number, type, countries and status) by text and one filter. Use for \"Which disasters are currently listed on ReliefWeb\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search with optional field prefix, for example 'earthquake' or 'title:flood'.","title":"Query"},"filter_field":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Field to filter on, for example country, disaster_type, format, source, theme, status or date.created (see ReliefWeb field tables).","title":"Filter Field"},"filter_value":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Value the filter field must have, for example 'Kenya' (leave empty to test only that the field exists).","title":"Filter Value"},"preset":{"anyOf":[{"enum":["latest","minimal","analysis"],"type":"string"},{"type":"null"}],"default":"latest","description":"Preset: latest (newest first, published items), minimal (default filters) or analysis (includes archived disasters and expired jobs and training).","title":"Preset"},"profile":{"anyOf":[{"enum":["minimal","list","full"],"type":"string"},{"type":"null"}],"default":"list","description":"Fields returned per item: minimal (title or name only), list (compact listing fields) or full (all fields).","title":"Profile"},"limit":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (0 to 1000; 0 returns only the total count).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many items (for paging).","title":"Offset"}},"title":"search_disastersArguments","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_countries":{"post":{"operationId":"list_countries","summary":"List ReliefWeb's country records (name, ISO3 code, status and description), optionally by text. Use for \"What is the Rel","description":"List ReliefWeb's country records (name, ISO3 code, status and description), optionally by text. Use for \"What is the ReliefWeb country entry for Kenya\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search with optional field prefix, for example 'earthquake' or 'title:flood'.","title":"Query"},"filter_field":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Field to filter on, for example country, disaster_type, format, source, theme, status or date.created (see ReliefWeb field tables).","title":"Filter Field"},"filter_value":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Value the filter field must have, for example 'Kenya' (leave empty to test only that the field exists).","title":"Filter Value"},"preset":{"anyOf":[{"enum":["latest","minimal","analysis"],"type":"string"},{"type":"null"}],"default":"latest","description":"Preset: latest (newest first, published items), minimal (default filters) or analysis (includes archived disasters and expired jobs and training).","title":"Preset"},"profile":{"anyOf":[{"enum":["minimal","list","full"],"type":"string"},{"type":"null"}],"default":"list","description":"Fields returned per item: minimal (title or name only), list (compact listing fields) or full (all fields).","title":"Profile"},"limit":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (0 to 1000; 0 returns only the total count).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many items (for paging).","title":"Offset"}},"title":"list_countriesArguments","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/search_jobs":{"post":{"operationId":"search_jobs","summary":"Search humanitarian job postings on ReliefWeb by text and one filter (country, career category, experience, source). Use","description":"Search humanitarian job postings on ReliefWeb by text and one filter (country, career category, experience, source). Use for \"Are there humanitarian jobs in Nairobi on ReliefWeb\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search with optional field prefix, for example 'earthquake' or 'title:flood'.","title":"Query"},"filter_field":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Field to filter on, for example country, disaster_type, format, source, theme, status or date.created (see ReliefWeb field tables).","title":"Filter Field"},"filter_value":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Value the filter field must have, for example 'Kenya' (leave empty to test only that the field exists).","title":"Filter Value"},"preset":{"anyOf":[{"enum":["latest","minimal","analysis"],"type":"string"},{"type":"null"}],"default":"latest","description":"Preset: latest (newest first, published items), minimal (default filters) or analysis (includes archived disasters and expired jobs and training).","title":"Preset"},"profile":{"anyOf":[{"enum":["minimal","list","full"],"type":"string"},{"type":"null"}],"default":"list","description":"Fields returned per item: minimal (title or name only), list (compact listing fields) or full (all fields).","title":"Profile"},"limit":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (0 to 1000; 0 returns only the total count).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many items (for paging).","title":"Offset"}},"title":"search_jobsArguments","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/search_training":{"post":{"operationId":"search_training","summary":"Search training opportunities and courses listed on ReliefWeb by text and one filter. Use for \"Find humanitarian trainin","description":"Search training opportunities and courses listed on ReliefWeb by text and one filter. Use for \"Find humanitarian training courses about logistics\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search with optional field prefix, for example 'earthquake' or 'title:flood'.","title":"Query"},"filter_field":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Field to filter on, for example country, disaster_type, format, source, theme, status or date.created (see ReliefWeb field tables).","title":"Filter Field"},"filter_value":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Value the filter field must have, for example 'Kenya' (leave empty to test only that the field exists).","title":"Filter Value"},"preset":{"anyOf":[{"enum":["latest","minimal","analysis"],"type":"string"},{"type":"null"}],"default":"latest","description":"Preset: latest (newest first, published items), minimal (default filters) or analysis (includes archived disasters and expired jobs and training).","title":"Preset"},"profile":{"anyOf":[{"enum":["minimal","list","full"],"type":"string"},{"type":"null"}],"default":"list","description":"Fields returned per item: minimal (title or name only), list (compact listing fields) or full (all fields).","title":"Profile"},"limit":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (0 to 1000; 0 returns only the total count).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many items (for paging).","title":"Offset"}},"title":"search_trainingArguments","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/search_sources":{"post":{"operationId":"search_sources","summary":"Search the organizations (sources) that publish on ReliefWeb, with type, homepage and country. Use for \"Which ReliefWeb ","description":"Search the organizations (sources) that publish on ReliefWeb, with type, homepage and country. Use for \"Which ReliefWeb sources are named UNICEF\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Free-text search with optional field prefix, for example 'earthquake' or 'title:flood'.","title":"Query"},"filter_field":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Field to filter on, for example country, disaster_type, format, source, theme, status or date.created (see ReliefWeb field tables).","title":"Filter Field"},"filter_value":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Value the filter field must have, for example 'Kenya' (leave empty to test only that the field exists).","title":"Filter Value"},"preset":{"anyOf":[{"enum":["latest","minimal","analysis"],"type":"string"},{"type":"null"}],"default":"latest","description":"Preset: latest (newest first, published items), minimal (default filters) or analysis (includes archived disasters and expired jobs and training).","title":"Preset"},"profile":{"anyOf":[{"enum":["minimal","list","full"],"type":"string"},{"type":"null"}],"default":"list","description":"Fields returned per item: minimal (title or name only), list (compact listing fields) or full (all fields).","title":"Profile"},"limit":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":10,"description":"How many items to return (0 to 1000; 0 returns only the total count).","title":"Limit"},"offset":{"anyOf":[{"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Skip this many items (for paging).","title":"Offset"}},"title":"search_sourcesArguments","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}}}}