openapi: 3.0.1 info: title: Yield AI V3 - BETA description: "

\n This API is in BETA. Please contact us to demo this API, or for more information on production scale models.\n

" version: '1.0' servers: - url: https://ag-analytics.azure-api.net/yieldv3 paths: /: post: summary: Yield Forecast description: "\n\n\n\n\n\n\n\n\n\n\nThe Ag-Analytics® Yield Forecast API uses Artificial Intelligence algorithms to forecast the yield on a given field, based on geospatial data. The Yield Model API provides service by considering various factors like soil, vegetation index, location of the field, planting varieties to forecast the yield for a given field. \n\nCrop yield is a function of a large set of parameters, many of which are outside the control of the farmer. The forces of nature are unpredictable and can make or break a growing season, while chemical applications can be rendered ineffective by new weeds or pests. The current version of the yield model is relatively simple as compared to the number of factors that actually influence yield, however, it still provides insight and predictive power. Current yield model factors are location, crop season, seeding characteristics, planting date, application characteristics, soil characteristics, past growing history, weather data, crop trait information, and past yields.\n

\n\n\n\n
\n

\n
\n\n\n
\n

Documentation

  \n\n\n\n

Github Repo

\n\n\n\n

Notebook

\n
\n
\n
\n\n\n

Sample API Specifications

\n

\nPlease contact us to demo \nour yield models. See sample API call below. \n

\n\n\n\n\n\n\n\n
\n \n
\n

Request Parameters

\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterData TypeRequired?OptionsDescription
MODELNAMETextYes\"NN\"The type of AI model to be used
(\"NN\" corresponds to neural network)
SHAPETextYesGeoJSONThe shape of the desired area-of-interest.
See example below.
ScalarVariablesListYesFour variables listed belowThe constants for the given shape -
includes all parameters below
PlantingDay1TextYes\"mm-dd-yyyy\"Date when planting occurred for
crop of interest.
HarvestDayTextYes\"mm-dd-yyyy\"Date when harvest is expected.
SeedingDensityIntegerYesAny numberThe number of seeds planted per acre.
CropSeasonTextYes2013-2019The growing season year for prediction.
\n
\n
\n\n\n\n \n
\n

Response Parameters

\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterTypeDescription
raster_filename--URL to download the result raster (.tif) file.
rasterinfo.attributes
CellSizeResolutionResolution of result geotiff file in meters
CoordinateSystem--Information about the projection of the raster
Extent--Extents of the result raster. Specifies the bottom left
and top right corners of the field raster in degrees.
LegendListLegend gives the following details for each range of values:
1. Area: Area covered in percentage
2. Count: # of pixels from the result raster in that range
3. CountAllPixels: total # of pixels in the result raster
4. Max: Max value in the range
5. Min: Minimum value in the range
6. Mean: Mean value in the range
7. Color: Hex color used for the range of values
MatrixListRows and columns containing below attributes
MaxNumberMaximum value from the result raster
MinNumberMinimum value from the result raster
MeanNumberAverage value from the result raster
Percentile5Number5th percentile value from the result raster
Percentile95Number95th percentile value from the result raster
pngb64Linkbase64png image of the result raster with legend entries
\n
\n
\n\n\n\n \n
\n

Shape Example - GeoJSON

\n
\n \"{\\\"type\\\":\\\"Feature\\\",\\\"geometry\\\":{\\\"type\\\":\\\"Polygon\\\",\\\"coordinates\\\":[[[-89.199484,40.972729],[-89.199773,40.97258],[-89.200135,40.972415],[-89.20034,40.972318],[-89.200445,40.972177],[-89.200439,40.972001],[-89.200404,40.971815],[-89.200245,40.971599],[-89.20004,40.971397],[-89.199869,40.971233],[-89.199865,40.971097],[-89.199952,40.970952],[-89.200264,40.97078],[-89.200517,40.970664],[-89.200903,40.970471],[-89.201168,40.970345],[-89.201324,40.970277],[-89.201407,40.970174],[-89.201428,40.970042],[-89.20271,40.970005],[-89.202738,40.970421],[-89.202844,40.970431],[-89.202851,40.970648],[-89.203123,40.970666],[-89.203216,40.973626],[-89.20332,40.973635],[-89.203281,40.972154],[-89.203277,40.972049],[-89.203227,40.970607],[-89.204645,40.97055],[-89.204639,40.970427],[-89.205456,40.970446],[-89.205638,40.970467],[-89.206002,40.970527],[-89.206306,40.97059],[-89.206516,40.970642],[-89.206711,40.97061],[-89.20688,40.970542],[-89.207086,40.970492],[-89.207267,40.970414],[-89.207449,40.970364],[-89.207667,40.970286],[-89.207849,40.970255],[-89.208057,40.970251],[-89.208287,40.970328],[-89.208494,40.970369],[-89.208672,40.970421],[-89.208866,40.970506],[-89.208972,40.970511],[-89.209009,40.970595],[-89.20893,40.970671],[-89.208736,40.970787],[-89.208535,40.970909],[-89.208325,40.971052],[-89.207907,40.971306],[-89.207633,40.971478],[-89.207313,40.971574],[-89.207065,40.971645],[-89.206566,40.971699],[-89.206246,40.971784],[-89.205998,40.971878],[-89.205548,40.972042],[-89.205013,40.97232],[-89.20468,40.972494],[-89.204246,40.972725],[-89.203988,40.972931],[-89.203819,40.973168],[-89.203666,40.973428],[-89.203616,40.973685],[-89.203552,40.973966],[-89.203548,40.9743],[-89.203411,40.974615],[-89.203284,40.974906],[-89.202723,40.975587],[-89.20283,40.975719],[-89.203383,40.975106],[-89.203522,40.974847],[-89.203658,40.974521],[-89.203723,40.974241],[-89.20381,40.97376],[-89.203891,40.973546],[-89.20407,40.973197],[-89.204197,40.973016],[-89.204369,40.972868],[-89.204686,40.972672],[-89.205018,40.972499],[-89.205351,40.972314],[-89.205742,40.972139],[-89.206047,40.971999],[-89.206367,40.971904],[-89.206907,40.971771],[-89.207303,40.971719],[-89.207551,40.971658],[-89.207846,40.971535],[-89.207938,40.971481],[-89.208059,40.971448],[-89.208267,40.971295],[-89.208534,40.971115],[-89.209089,40.970762],[-89.209108,40.971493],[-89.209143,40.972829],[-89.209176,40.974108],[-89.209236,40.977186],[-89.20442,40.977285],[-89.199613,40.977383],[-89.199533,40.974593],[-89.199484,40.972729]]]}}\"\n
\n \n
\n\n\n\n

Request Example

\n
\n{\n\"MODELNAME\": \"NN\",\n\"SHAPE\": \"{\\\"type\\\":\\\"Feature\\\",\\\"geometry\\\":{\\\"type\\\":\\\"Polygon\\\",\\\"coordinates\\\":[[[-89.199484,40.972729],[-89.199773,40.97258],[-89.200135,40.972415],[-89.20034,40.972318],[-89.200445,40.972177],[-89.200439,40.972001],[-89.200404,40.971815],[-89.200245,40.971599],[-89.20004,40.971397],[-89.199869,40.971233],[-89.199865,40.971097],[-89.199952,40.970952],[-89.200264,40.97078],[-89.200517,40.970664],[-89.200903,40.970471],[-89.201168,40.970345],[-89.201324,40.970277],[-89.201407,40.970174],[-89.201428,40.970042],[-89.20271,40.970005],[-89.202738,40.970421],[-89.202844,40.970431],[-89.202851,40.970648],[-89.203123,40.970666],[-89.203216,40.973626],[-89.20332,40.973635],[-89.203281,40.972154],[-89.203277,40.972049],[-89.203227,40.970607],[-89.204645,40.97055],[-89.204639,40.970427],[-89.205456,40.970446],[-89.205638,40.970467],[-89.206002,40.970527],[-89.206306,40.97059],[-89.206516,40.970642],[-89.206711,40.97061],[-89.20688,40.970542],[-89.207086,40.970492],[-89.207267,40.970414],[-89.207449,40.970364],[-89.207667,40.970286],[-89.207849,40.970255],[-89.208057,40.970251],[-89.208287,40.970328],[-89.208494,40.970369],[-89.208672,40.970421],[-89.208866,40.970506],[-89.208972,40.970511],[-89.209009,40.970595],[-89.20893,40.970671],[-89.208736,40.970787],[-89.208535,40.970909],[-89.208325,40.971052],[-89.207907,40.971306],[-89.207633,40.971478],[-89.207313,40.971574],[-89.207065,40.971645],[-89.206566,40.971699],[-89.206246,40.971784],[-89.205998,40.971878],[-89.205548,40.972042],[-89.205013,40.97232],[-89.20468,40.972494],[-89.204246,40.972725],[-89.203988,40.972931],[-89.203819,40.973168],[-89.203666,40.973428],[-89.203616,40.973685],[-89.203552,40.973966],[-89.203548,40.9743],[-89.203411,40.974615],[-89.203284,40.974906],[-89.202723,40.975587],[-89.20283,40.975719],[-89.203383,40.975106],[-89.203522,40.974847],[-89.203658,40.974521],[-89.203723,40.974241],[-89.20381,40.97376],[-89.203891,40.973546],[-89.20407,40.973197],[-89.204197,40.973016],[-89.204369,40.972868],[-89.204686,40.972672],[-89.205018,40.972499],[-89.205351,40.972314],[-89.205742,40.972139],[-89.206047,40.971999],[-89.206367,40.971904],[-89.206907,40.971771],[-89.207303,40.971719],[-89.207551,40.971658],[-89.207846,40.971535],[-89.207938,40.971481],[-89.208059,40.971448],[-89.208267,40.971295],[-89.208534,40.971115],[-89.209089,40.970762],[-89.209108,40.971493],[-89.209143,40.972829],[-89.209176,40.974108],[-89.209236,40.977186],[-89.20442,40.977285],[-89.199613,40.977383],[-89.199533,40.974593],[-89.199484,40.972729]]]}}\",\n\"ScalarVariables\": {\n\"CropSeason\": \"2018\",\n\"PlantingDay1\": \"05/20/2018\",\n\"SeedingDensity\": \"30000\",\n\"HarvestDay\": \"10/20/2018\"\n}\n}\n
\n \n
\n\n\n\n

Response Example

\n
\n{\n  \"raster_filename\": \"result_yieldraster_20191121_222140_9894.tif\",\n  \"rasterinfo\": [\n    {\n      \"attributes\": {\n        \"CellSize\": [\n          0.0001,\n          -0.0001\n        ],\n        \"CoordinateSystem\": \"GEOGCS[\\\"WGS 84\\\",DATUM[\\\"WGS_1984\\\",SPHEROID[\\\"WGS 84\\\",6378137,298.257223563,AUTHORITY[\\\"EPSG\\\",\\\"7030\\\"]],AUTHORITY[\\\"EPSG\\\",\\\"6326\\\"]],PRIMEM[\\\"Greenwich\\\",0],UNIT[\\\"degree\\\",0.0174532925199433],AUTHORITY[\\\"EPSG\\\",\\\"4326\\\"]]\",\n        \"Extent\": \"-89.209236, 40.969983000000006, -89.19953600000001, 40.977383\",\n        \"Legend\": [\n          {\n            \"Area\": \"100.0 %\",\n            \"Count\": 6511,\n            \"CountAllPixels\": 6511,\n            \"Value\": 1.0,\n            \"Variety\": \"Variety 1.0\",\n            \"color\": \"#6e9a9e\"\n          }\n        ],\n        \"Matrix\": [\n          74,\n          97\n        ],\n        \"Max\": 1.0,\n        \"Mean\": 1.0,\n        \"Min\": 1.0,\n        \"OID\": 0,\n        \"Percentile5\": 1.0,\n        \"Percentile95\": 1.0,\n        \"Variety\": \"Variety\",\n        \"pngb64\": \"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAGEAAABKCAYAAACrbTpWAAAB6klEQVR4nO2ZMZKDMAxFP5lcgQtSUOYwlFvsBfcS26xnMl4bDDHwJf1XZZIikp6QwAwwzOvr++fuGD5lmafx6SER6zzuDkBIAgWSQIAkECAJBEgCAZJAgCQQIAkESAIBkkCAJBAgCQRIAgGSQIAkEBBawjJP490xAIElLPM0srxVDCuBRQAQWAITkkBAKAksizgnjASmRZwTRgKrACCIBNYxlAghgZ0QEphHERBAAvsoAgJIYL8KgAASLCAJBLiWYGEfAI4lWBEAOJZgCUkgQBIIcCkh7QMLzwiAUwlWip9wKYH53UEJlxKs4U6CtasAcCbBogDAmQSLAgAnEiwdUZQwL8HqCHrHrARrD2RrmJPgqfgplwGwkZCHsZPId5gZCR6o3UA8rw4kIlt3b3Q7wfrtZk5LPjQSPC3cvdBIiFj8xOUSvI2bLVqa63QJedEjdvxWzt0k1Do8YtFLrNWhmwQVe5tajWgWcxRKInZJiLZUr6JZgqezGzaaJUjAeaxK0Pi5hqIEz0cIjI2lo+yLKTXBY+1H0Y9lnsZajYf0QVfDObQ09yUvde46P9oqwJlx7JksQ/5Fr8COjLc9/91jfJ4h4Uhc/yQkjgRoda/0kPFJ7lUJObVArRb+nU8k9Mi/WYJnjkrw0IDij18vdrpMAEXhUgAAAABJRU5ErkJggg==\"\n      }\n    }\n  ]\n}\n
\n \n
\n
\n
\n
\n
\n\n
\n
\n
" operationId: yield-forecast requestBody: content: application/json: example: MODELNAME: NN SHAPE: '{"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[-89.199484,40.972729],[-89.199773,40.97258],[-89.200135,40.972415],[-89.20034,40.972318],[-89.200445,40.972177],[-89.200439,40.972001],[-89.200404,40.971815],[-89.200245,40.971599],[-89.20004,40.971397],[-89.199869,40.971233],[-89.199865,40.971097],[-89.199952,40.970952],[-89.200264,40.97078],[-89.200517,40.970664],[-89.200903,40.970471],[-89.201168,40.970345],[-89.201324,40.970277],[-89.201407,40.970174],[-89.201428,40.970042],[-89.20271,40.970005],[-89.202738,40.970421],[-89.202844,40.970431],[-89.202851,40.970648],[-89.203123,40.970666],[-89.203216,40.973626],[-89.20332,40.973635],[-89.203281,40.972154],[-89.203277,40.972049],[-89.203227,40.970607],[-89.204645,40.97055],[-89.204639,40.970427],[-89.205456,40.970446],[-89.205638,40.970467],[-89.206002,40.970527],[-89.206306,40.97059],[-89.206516,40.970642],[-89.206711,40.97061],[-89.20688,40.970542],[-89.207086,40.970492],[-89.207267,40.970414],[-89.207449,40.970364],[-89.207667,40.970286],[-89.207849,40.970255],[-89.208057,40.970251],[-89.208287,40.970328],[-89.208494,40.970369],[-89.208672,40.970421],[-89.208866,40.970506],[-89.208972,40.970511],[-89.209009,40.970595],[-89.20893,40.970671],[-89.208736,40.970787],[-89.208535,40.970909],[-89.208325,40.971052],[-89.207907,40.971306],[-89.207633,40.971478],[-89.207313,40.971574],[-89.207065,40.971645],[-89.206566,40.971699],[-89.206246,40.971784],[-89.205998,40.971878],[-89.205548,40.972042],[-89.205013,40.97232],[-89.20468,40.972494],[-89.204246,40.972725],[-89.203988,40.972931],[-89.203819,40.973168],[-89.203666,40.973428],[-89.203616,40.973685],[-89.203552,40.973966],[-89.203548,40.9743],[-89.203411,40.974615],[-89.203284,40.974906],[-89.202723,40.975587],[-89.20283,40.975719],[-89.203383,40.975106],[-89.203522,40.974847],[-89.203658,40.974521],[-89.203723,40.974241],[-89.20381,40.97376],[-89.203891,40.973546],[-89.20407,40.973197],[-89.204197,40.973016],[-89.204369,40.972868],[-89.204686,40.972672],[-89.205018,40.972499],[-89.205351,40.972314],[-89.205742,40.972139],[-89.206047,40.971999],[-89.206367,40.971904],[-89.206907,40.971771],[-89.207303,40.971719],[-89.207551,40.971658],[-89.207846,40.971535],[-89.207938,40.971481],[-89.208059,40.971448],[-89.208267,40.971295],[-89.208534,40.971115],[-89.209089,40.970762],[-89.209108,40.971493],[-89.209143,40.972829],[-89.209176,40.974108],[-89.209236,40.977186],[-89.20442,40.977285],[-89.199613,40.977383],[-89.199533,40.974593],[-89.199484,40.972729]]]},"properties":{"OBJECTID":5102679,"CALCACRES":145.08999634,"CALCACRES2":null},"id":5102679}' SeedingDensity: 30000 ModelType: NN ModelVersion: v3.1.0 CropSeason: 2017 CropName: CORN PlantingDay: '2017-04-01' CornAfterCorn: 0 responses: '200': description: get: summary: Yield Forecast description: "\n\n\n\n\n\nThe Ag-Analytics Yield Forecast GET API allows a user to easily \"fetch\" and download locally a resulting .tif from the Yield Forecast POST API.\n

\n\nThe Ag-Analytics® Yield Forecast model uses Artificial Intelligence algorithms to forecast the yield on a given field, based on geospatial data. This provides service by considering various factors like soil, vegetation index, location of the field, planting varieties to forecast the yield for a given field. \nCrop yield is a function of a large set of parameters, many of which are outside the control of the farmer. The forces of nature are unpredictable and can make or break a growing season, while chemical applications can be rendered ineffective by new weeds or pests. The current version of the yield model is relatively simple as compared to the number of factors that actually influence yield, however, it still provides insight and predictive power. Current yield model factors are location, crop season, seeding characteristics, planting date, application characteristics, soil characteristics, past growing history, weather data, crop trait information, and past yields.\n

\n\n
\n\n\n\n \n

\n\n\n
\n

Documentation

  \n\n\n\n

Github Repo

\n\n\n\n

Notebook

\n
\n
\n
\n\n\n

Sample API Specifications

\n

\nPlease contact us to demo \nour yield models. See sample API call below. \n

\n\n\n\n\n\n\n\n

GET Request

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ParameterDescriptionExampleRequest
filenameFile name to download. From POST request.
Only request a single file at a time.
result_yieldraster_20191212_143557_3357.tifhttps://ag-analytics.azure-api.net/yieldforecast/?filename=result_yieldraster_20191212_143557_3357.tif
\n
\n
" operationId: get-yield-forecast parameters: - name: filename in: query description: Filename of resulting raster from POST Yield Forecast API. schema: enum: - '' type: '' responses: '200': description: components: { }