{ "openapi": "3.1.1", "info": { "title": "ERP-GPT-Europe Tool API", "version": "1.0.0" }, "servers": [ { "url": "https://api.erp-soilgpt.uk/" } ], "paths": { "/resolve_place": { "post": { "summary": "Resolve a place name to coordinates, bounding box, and GADM region", "description": "Use this tool to resolve a place name or fallback country into coordinates, bounding box, and GADM ID using Nominatim and hierarchical region matching. Useful as the first step before spatial or soil queries.", "operationId": "resolve_place", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "place_name": { "type": "string", "description": "The name of the place to resolve, such as 'Kisumu' or 'Lake Victoria'." }, "fallback": { "type": "string", "description": "Optional fallback country to help disambiguate the place, e.g., 'Kenya'." }, "session_name": { "type": "string", "description": "A required session identifier (random, internal) to ensure output file isolation." } }, "required": [ "place_name", "session_name" ] } } } }, "responses": { "200": { "description": "Successful place resolution with coordinates, bounding box, and GADM region", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Text message describing the result or fallback used" }, "used_name": { "type": [ "string", "null" ], "description": "The actual query string used, possibly with fallback country appended" }, "latitude": { "type": [ "number", "null" ], "description": "Latitude in decimal degrees (WGS84)" }, "longitude": { "type": [ "number", "null" ], "description": "Longitude in decimal degrees (WGS84)" }, "bbox_area": { "type": [ "number", "null" ], "description": "Approximate area of the bounding box in square degrees" }, "gid": { "type": [ "string", "null" ], "description": "Best matching GADM ID (e.g., 'KEN.1.3_1') or null if not found" } } } } } } } } }, "/gadm/find_gid": { "post": { "summary": "Find the best matching GADM region for a location", "description": "Given a geographic point (latitude and longitude), this tool returns the most likely GADM administrative region ID (GID). If `return_all` is true, it returns a list of all matching regions (from leaf to higher levels), sorted by bounding-box similarity. Typically used after /resolve_place.", "operationId": "gadm_find_gid", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "lat": { "type": "number", "description": "Latitude of the location (in decimal degrees)" }, "lon": { "type": "number", "description": "Longitude of the location (in decimal degrees)" }, "bbox_area": { "type": "number", "nullable": true, "description": "Optional bounding box area (in square degrees) used to select the best matching GADM region when multiple regions contain the point" }, "return_all": { "type": "boolean", "default": false, "description": "If true, returns a list of all matching GADM regions; otherwise returns only the best match" } }, "required": [ "lat", "lon" ] } } } }, "responses": { "200": { "description": "Matching region(s) with status", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Message describing result — e.g., success or failure" }, "gid": { "type": [ "string", "null" ], "description": "Best matching GADM ID (e.g., 'UGA.2.5_1'), or null if no match" } }, "required": [ "status", "gid" ] }, { "type": "object", "properties": { "status": { "type": "string", "description": "Message describing result — e.g., success or failure" }, "gids": { "type": "array", "items": { "type": "string" }, "description": "List of all matching GADM region IDs" } }, "required": [ "status", "gids" ] } ] } } } } } } }, "/gadm/get_full_name": { "post": { "summary": "Get the full hierarchical name of a GADM region", "description": "Returns a semicolon-separated string of the full hierarchy for a given GADM ID (e.g., 'Subcounty; County; Country'). This is useful for showing human-readable names after identifying a region by GID.", "operationId": "gadm_get_full_name", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gid": { "type": "string", "description": "The GADM ID to query, e.g., 'KEN.1.2_1'" } }, "required": [ "gid" ] } } } }, "responses": { "200": { "description": "Full name result with status", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Indicates whether the GADM ID was found" }, "full_name": { "type": [ "string", "null" ], "description": "Hierarchical name from smallest to country level (semicolon-separated), or null if not found" } }, "required": [ "status", "full_name" ] } } } } } } }, "/gadm/get_geometry_info": { "post": { "summary": "Get spatial metadata of a GADM region", "description": "Returns the centroid and bounding box of the polygon associated with a given GADM ID. Results are flattened at the top level for easier access. Useful for map settings, distance reasoning, or visualisation.", "operationId": "gadm_get_geometry_info", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gid": { "type": "string", "description": "The GADM ID to query (e.g., 'UGA.2.5_1')" } }, "required": [ "gid" ] } } } }, "responses": { "200": { "description": "Centroid and bounding box of the polygon region", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Message indicating success or failure" }, "latitude": { "type": [ "number", "null" ], "description": "Latitude of the centroid" }, "longitude": { "type": [ "number", "null" ], "description": "Longitude of the centroid" }, "bbox_bounds": { "type": [ "array", "null" ], "items": { "type": "number" }, "minItems": 4, "maxItems": 4, "description": "[lat_min, lat_max, lon_min, lon_max]" }, "polygon_area": { "type": [ "number", "null" ], "description": "Area of the polygon in degrees²" }, "bbox_area": { "type": [ "number", "null" ], "description": "Area of the bounding box in degrees²" } }, "required": [ "status" ] } } } } } } }, "/gadm/get_tree_info": { "post": { "summary": "Get hierarchical tree metadata for a GADM region", "description": "Returns the level of the GADM ID and its relationship to other regions: parent (if any), children, and siblings. This is useful for navigating the administrative hierarchy or exploring neighbouring regions.", "operationId": "gadm_get_tree_info", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gid": { "type": "string", "description": "The GADM ID to query (e.g., 'ETH.2.9_1')" } }, "required": [ "gid" ] } } } }, "responses": { "200": { "description": "Level, parent, children, and siblings", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status message indicating success or failure" }, "level": { "type": [ "integer", "null" ], "description": "Administrative level (0 = country, 1 = province, ..., 5 = smallest)" }, "parent": { "type": [ "string", "null" ], "description": "Parent GADM ID, or null if this is level 0" }, "children": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "List of child GIDs" }, "siblings": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "List of sibling GIDs, including self" } }, "required": [ "status" ] } } } } } } }, "/gadm/get_quick_summary": { "post": { "summary": "Return a human-readable summary of a GADM region", "description": "Returns a concise, readable string describing the GADM region: full name, level, latitude, longitude, and GID. Useful for debugging or confirming spatial resolution results before data retrieval.", "operationId": "gadm_get_quick_summary", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "gid": { "type": "string", "description": "GADM ID to summarise (e.g., 'ETH.1.3_1')" } }, "required": [ "gid" ] } } } }, "responses": { "200": { "description": "Single-line summary of the region", "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "type": "string", "description": "Human-readable summary or error message" }, "status": { "type": "string", "description": "Indicates success or failure of the summary request" } }, "required": [ "summary", "status" ] } } } } } } }, "/soil/get_point": { "post": { "summary": "Retrieve soil data near a location", "description": "Returns soil property values from the best matching sample among the top-k nearest points. The full list of valid property names is available in `column_names.json`. Any unknown property causes immediate failure.", "operationId": "soil_get_point", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "place": { "description": "GADM ID string, place name string, or [lat, lon] coordinate pair.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "number" }, "minItems": 2, "maxItems": 2 } ] }, "properties": { "type": "array", "description": "List of requested soil properties. Valid names must match entries in `column_names.json`.", "items": { "type": "string" } }, "distance_top_k": { "type": "integer", "description": "Number of nearest samples to consider.", "minimum": 1, "default": 20 }, "distance_limit": { "type": "number", "description": "Maximum allowed distance in meters.", "minimum": 0, "default": 200000 }, "session_name": { "type": "string", "nullable": true, "description": "Optional session identifier for logging or traceability." } }, "required": [ "place", "properties" ] } } } }, "responses": { "200": { "description": "Structured soil data response", "content": { "application/json": { "schema": { "type": "object", "properties": { "query_input": { "type": "object", "description": "Echo of user input" }, "query_status": { "type": "string", "description": "Human-readable status message" }, "query_output": { "type": "object", "nullable": true, "description": "Present only on success or partial success", "example": { "LAT_LONG": [ 52.13, 5.37 ], "GADM_IDS": [ "NLD.5.2_1" ], "carbon": { "soil_organic_carbon": 12.4 }, "entry_key": "NL123456" } } }, "required": [ "query_input", "query_status", "query_output" ] } } } } } } }, "/soil/get_map": { "post": { "summary": "Generate scatter-plot maps for soil properties across a region", "description": "Extracts all samples within the target region and generates one PNG map per property. The response contains `query_input`, `query_status`, and a flat `query_output` mapping property names to either a plot URL or a warning message. For valid property names see `column_names.json`.", "operationId": "soil_get_map", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "place": { "description": "GADM ID, place name string, or [lat, lon, bbox_area] triple", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "number" }, "minItems": 3, "maxItems": 3 } ] }, "properties": { "type": "array", "description": "List of requested soil properties. Each entry must match a full_name in `column_names.json` (e.g., \"carbon:total (g/kg)\"). Maximum 5 properties per request.", "items": { "type": "string" }, "maxItems": 5 }, "session_name": { "type": "string", "description": "Required session identifier. Used to namespace generated plot files (ASCII only)." }, "kwargs": { "type": "object", "description": "Optional additional keyword arguments forwarded to the plotting function.", "additionalProperties": true } }, "required": [ "place", "properties", "session_name" ] } } } }, "responses": { "200": { "description": "Map generation result containing URLs or warning strings per property", "content": { "application/json": { "schema": { "type": "object", "properties": { "query_input": { "type": "object", "description": "Echo of the input parameters" }, "query_status": { "type": "string", "description": "Success, failure, or partial success message" }, "query_output": { "type": "object", "description": "Flat mapping: full property name → URL (.png) or warning string", "additionalProperties": { "type": "string" } } }, "required": [ "query_input", "query_status", "query_output" ] } } } } } } }, "/health": { "get": { "summary": "Health check", "description": "Returns status OK if the ERP-GPT-Europe backend is running.", "operationId": "health_check", "responses": { "200": { "description": "Health check successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "OK" } }, "required": [ "status" ] } } } } } } } } }