Datasets:
File size: 24,711 Bytes
b8bc5ba | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 | {
"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"
]
}
}
}
}
}
}
}
}
}
|