Skip to content

Vantage API (3.0.1)

REST API for queuing and running geospatial analyses on user plots. Create jobs, validate and queue plots, and retrieve per-plot analysis results (e.g., EUDR, deforestation, protected areas).

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://open-atlas.com/contact
Ahmed Elfouly
info@open-atlas.com
License
OpenAtlas - User License Agreement
Languages
Servers
Mock server
https://api.open-atlas.com/_mock/openapi/

Login to receive a JWT

Request

Authenticates a user using Basic Auth credentials and returns a JWT token if successful.

Headers
Authorizationstringrequired

Authorization header with Basic Auth format 'Basic base64(username:password)'

Example: Basic bXJmb3VseTptcnBhc3N3b3Jk
Bodyapplication/jsonrequired

Basic Authorization header with encoded username and password

curl -i -X POST \
  https://api.open-atlas.com/_mock/openapi/login \
  -H 'Authorization: Basic bXJmb3VseTptcnBhc3N3b3Jk' \
  -H 'Content-Type: application/json'

Responses

User authenticated successfully. JWT token returned in the response.

Bodyapplication/json
tokenstring

JSON Web Token (JWT)

Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature"
Response
application/json
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature"
}

Create a new plot

Request

Creates a new plot based on the given geojson and metadata

Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
Bodyapplication/jsonrequired

Details of the plot to create

geojsonobject(GeoJson)required

GeoJSON representation of the plot's geographical data

Example: {"type":"FeatureCollection","features":[{"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[20.01750003723791,-0.03010959663886581],[20.01857837976968,-0.029779656058593673],[20.01958831997618,-0.031143678695514154],[20.018349030798674,-0.03160640023472183],[20.017491989905864,-0.03011764397074046]]]}}]}
geojson.​typestringrequired
Example: "FeatureCollection"
geojson.​featuresArray of objects(GeoJsonFeature)required

A list of GeoJson Features that this FeatureCollection is made of

Example: [{"type":"Feature","geometry":{"type":"Polygon","coordinates":[[[20.01750003723791,-0.03010959663886581],[20.01857837976968,-0.029779656058593673],[20.01958831997618,-0.031143678695514154],[20.018349030798674,-0.03160640023472183],[20.017491989905864,-0.03011764397074046]]]}}]
geojson.​features[].​geometryPoint (object) or Polygon (object)(Geometry)required

Geometry object defining the spatial aspect of the feature, can be either Point or Polygon

One of:

Geometry object defining the spatial aspect of the feature, can be either Point or Polygon

geojson.​features[].​geometry.​typestring
geojson.​features[].​geometry.​coordinatesArray of numbers(double)required

An array of 2 coordinates [longitude, latitude]

Example: [20.01750003723791,-0.03010959663886581]
geojson.​features[].​propertiesobject

Additional properties for the feature as key-value pairs. Optional properties include point_ha (float < 4.0)

Example: {"point_ha":3.5}
geojson.​features[].​typestringrequired

Type of the GeoJSON feature

Example: "Feature"
harvest_datestring(date)

The harvest date of the plot and the end date of analysis, in the format yyyy-MM-dd; if not provided here, it must be specified when executing the job

Example: "2023-11-01"
commoditystring

The commodity type planted in the plot for analysis; if not provided here, it must be specified when executing the job

Enum"wood""soy""cocoa""coffee""palm_oil""beef""rubber"
Example: "wood"
plot_namestring

Name assigned to the plot

Example: "My sustainable plot"
notesstring

Additional notes related to the plot

Example: "GeoJSON needs to be revised"
additional_infoobject

Additional information as key-value pairs

Example: {"previous_risk_assessment":"high","urgency":"low"}
curl -i -X POST \
  https://api.open-atlas.com/_mock/openapi/plots/make_plot \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature' \
  -H 'Content-Type: application/json' \
  -d '{
    "geojson": {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  20.01750003723791,
                  -0.03010959663886581
                ],
                [
                  20.01857837976968,
                  -0.029779656058593673
                ],
                [
                  20.01958831997618,
                  -0.031143678695514154
                ],
                [
                  20.018349030798674,
                  -0.03160640023472183
                ],
                [
                  20.017491989905864,
                  -0.03011764397074046
                ]
              ]
            ]
          }
        }
      ]
    },
    "harvest_date": "2023-11-01",
    "commodity": "wood",
    "plot_name": "My sustainable plot",
    "notes": "GeoJSON needs to be revised",
    "additional_info": {
      "previous_risk_assessment": "high",
      "urgency": "low"
    }
  }'

Responses

Plot created successfully

Bodyapplication/json
usernamestring

Username of the account that created the plot, the plot owner

Example: "jdoe"
countrystring

Country where the plot is located

Example: "United States"
statestring

State or region where the plot is located

Example: "California"
notesstring

Additional notes related to the plot

Example: "This plot requires frequent irrigation."
analysisobject(Analysis)

Complete analysis data for a plot

plot_idstring

Unique identifier for the plot

Example: "ef6f5727-377f-4e9d-abcb-74a8a6bf0366"
plot_namestring

Name of the plot

Example: "East Field"
geojson_featuresArray of objects(GeoJsonFeature)
harvest_datesArray of strings(date)
Example: ["2024-11-01"]
commoditystring

Type of commodity planted in the plot to do analysis on

Enum"wood""soy""cocoa""coffee""palm_oil""beef""rubber"
Example: "cocoa"
latstring

Latitude of the plot's center

Example: "34.052235"
lonstring

Longitude of the plot's center

Example: "-118.243683"
area_hanumber(double)

Area of the plot in hectares

Example: 12.5
tokens_costinteger(int32)

Cost of the analyzing the plot in tokens

Example: 150
created_atstring(date-time)

Timestamp of plot creation

updated_atstring(date-time)

Timestamp of the last plot update

analysis_imagestring

URL for the visualization of the analysis of the plot

Example: "https://example.com/images/plot-analysis.jpg"
additional_infoobject

Additional information about the plot as key-value pairs

Example: {"soil_quality":"high","access":"restricted"}
Response
application/json
{
  "username": "jdoe",
  "country": "United States",
  "state": "California",
  "notes": "This plot requires frequent irrigation.",
  "analysis": {
    "analysisEnd": "2024-02-29",
    "analysis_end": "2024-02-29",
    "risk_level": "Low",
    "forest_percentage_2020": 93.07,
    "indigenous_land": { … },
    "logging_area": 1.08,
    "forest_area_2020": 145.31,
    "risk_reason": "Low: Low deforestation detection",
    "version": "2024-11-13",
    "areaHa": 156.13,
    "protected_areas": { … },
    "deforestation": { … },
    "deforestation_percentage": 0.044,
    "protectedAreas": [ … ],
    "indigenous_overlap": { … }
  },
  "plot_id": "ef6f5727-377f-4e9d-abcb-74a8a6bf0366",
  "plot_name": "East Field",
  "geojson_features": [
    { … }
  ],
  "harvest_dates": [
    "2024-11-01"
  ],
  "commodity": "cocoa",
  "lat": "34.052235",
  "lon": "-118.243683",
  "area_ha": 12.5,
  "tokens_cost": 150,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "analysis_image": "https://example.com/images/plot-analysis.jpg",
  "additional_info": {
    "soil_quality": "high",
    "access": "restricted"
  }
}

Retrieve plot details

Request

Fetches details of a specific plot by its unique plot_id

Path
plot_idstringrequired
Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
curl -i -X GET \
  'https://api.open-atlas.com/_mock/openapi/plots/plot/{plot_id}' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature'

Responses

Plots details retrieved successfully

Bodyapplication/json
usernamestring

Username of the account that created the plot, the plot owner

Example: "jdoe"
countrystring

Country where the plot is located

Example: "United States"
statestring

State or region where the plot is located

Example: "California"
notesstring

Additional notes related to the plot

Example: "This plot requires frequent irrigation."
analysisobject(Analysis)

Complete analysis data for a plot

plot_idstring

Unique identifier for the plot

Example: "ef6f5727-377f-4e9d-abcb-74a8a6bf0366"
plot_namestring

Name of the plot

Example: "East Field"
geojson_featuresArray of objects(GeoJsonFeature)
harvest_datesArray of strings(date)
Example: ["2024-11-01"]
commoditystring

Type of commodity planted in the plot to do analysis on

Enum"wood""soy""cocoa""coffee""palm_oil""beef""rubber"
Example: "cocoa"
latstring

Latitude of the plot's center

Example: "34.052235"
lonstring

Longitude of the plot's center

Example: "-118.243683"
area_hanumber(double)

Area of the plot in hectares

Example: 12.5
tokens_costinteger(int32)

Cost of the analyzing the plot in tokens

Example: 150
created_atstring(date-time)

Timestamp of plot creation

updated_atstring(date-time)

Timestamp of the last plot update

analysis_imagestring

URL for the visualization of the analysis of the plot

Example: "https://example.com/images/plot-analysis.jpg"
additional_infoobject

Additional information about the plot as key-value pairs

Example: {"soil_quality":"high","access":"restricted"}
Response
application/json
{
  "username": "jdoe",
  "country": "United States",
  "state": "California",
  "notes": "This plot requires frequent irrigation.",
  "analysis": {
    "analysisEnd": "2024-02-29",
    "analysis_end": "2024-02-29",
    "risk_level": "Low",
    "forest_percentage_2020": 93.07,
    "indigenous_land": { … },
    "logging_area": 1.08,
    "forest_area_2020": 145.31,
    "risk_reason": "Low: Low deforestation detection",
    "version": "2024-11-13",
    "areaHa": 156.13,
    "protected_areas": { … },
    "deforestation": { … },
    "deforestation_percentage": 0.044,
    "protectedAreas": [ … ],
    "indigenous_overlap": { … }
  },
  "plot_id": "ef6f5727-377f-4e9d-abcb-74a8a6bf0366",
  "plot_name": "East Field",
  "geojson_features": [
    { … }
  ],
  "harvest_dates": [
    "2024-11-01"
  ],
  "commodity": "cocoa",
  "lat": "34.052235",
  "lon": "-118.243683",
  "area_ha": 12.5,
  "tokens_cost": 150,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "analysis_image": "https://example.com/images/plot-analysis.jpg",
  "additional_info": {
    "soil_quality": "high",
    "access": "restricted"
  }
}

List user's plots

Request

Returns the authenticated user's plots with keyset pagination (newest first).

Query
limitinteger(int32)

Maximum number of items to return (default 100, max 1000)

Default 100
cursorstring

Opaque cursor for the next page

created_at_fromstring

Filter: inclusive lower bound for created_at (ISO-8601)

created_at_untilstring

Filter: inclusive upper bound for created_at (ISO-8601)

liteboolean

When true, returns lightweight summaries with pagination meta; when false, returns full PlotDTOv2 list

Default false
Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
curl -i -X GET \
  'https://api.open-atlas.com/_mock/openapi/plots?limit=100&cursor=string&created_at_from=string&created_at_until=string&lite=false' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature'

Responses

List of Plot details retrieved successfully

Bodyapplication/json
plotsArray of objects(Plot)

List of plots

metaobject

Pagination metadata containing has_more, next_cursor, limit, and count

Example: {"next_cursor":"eyJsZWsiOiJZM0psWVhSbFpFRjBIbE02TWpBeU5TMHdOeTB6TVZReE56b3lNem8xTVI5d2JHOTBTV1FlVXpwak9EWTVaRFJsWlMwM09EZ3lMVFJoTjJFdFlqSmhaQzB4TWpkak1XRXlNemM0TjJNZmRYTmxjbTVoYldVZVV6cHZjR1Z1WVhSc1lYTmZiV0ZwYmciLCJ1Ijoib3BlbmF0bGFzX21haW4iLCJ2IjoxLCJleHAiOjE3NTYzMDc3OTY1MDgsImlhdCI6MTc1NjMwNTk5NjUwOH0.J1gFjyqEdHEmSYgaUVLH-YYePiBxNTc82LOXTowRjbA","limit":100,"count":100,"has_more":true}
Response
application/json
{
  "plots": [
    { … }
  ],
  "meta": {
    "next_cursor": "eyJsZWsiOiJZM0psWVhSbFpFRjBIbE02TWpBeU5TMHdOeTB6TVZReE56b3lNem8xTVI5d2JHOTBTV1FlVXpwak9EWTVaRFJsWlMwM09EZ3lMVFJoTjJFdFlqSmhaQzB4TWpkak1XRXlNemM0TjJNZmRYTmxjbTVoYldVZVV6cHZjR1Z1WVhSc1lYTmZiV0ZwYmciLCJ1Ijoib3BlbmF0bGFzX21haW4iLCJ2IjoxLCJleHAiOjE3NTYzMDc3OTY1MDgsImlhdCI6MTc1NjMwNTk5NjUwOH0.J1gFjyqEdHEmSYgaUVLH-YYePiBxNTc82LOXTowRjbA",
    "limit": 100,
    "count": 100,
    "has_more": true
  }
}

List analysis runs for a plot

Request

Returns all analysis runs associated with the provided plot_id. Each item summarizes the run, including status, timing, tokens cost, and links to artifacts.

Query
plot_idstringrequired

Plot ID to list runs for

plot_idstring
Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
curl -i -X GET \
  'https://api.open-atlas.com/_mock/openapi/analysis-runs?plot_id=string%2Cstring' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature'

Responses

Successful response

Bodyapplication/jsonArray [
run_idstring
job_idstring
plot_idstring
check_typestring
effective_configobject
statusstring
errorstring
analysis_imagestring
tokens_costinteger(int32)
created_atstring
updated_atstring
analysisobject(Analysis)

Complete analysis data for a plot

]
Response
application/json
[
  {
    "run_id": "string",
    "job_id": "string",
    "plot_id": "string",
    "check_type": "string",
    "effective_config": { … },
    "status": "string",
    "error": "string",
    "analysis_image": "string",
    "tokens_cost": 0,
    "created_at": "string",
    "updated_at": "string",
    "analysis": { … }
  }
]

Retrieve analysis run details

Request

Returns the full analysis run details for the provided run_id, including analysis output, status, configuration used, and artifact links.

Path
run_idstringrequired
Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
curl -i -X GET \
  'https://api.open-atlas.com/_mock/openapi/analysis-runs/{run_id}' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature'

Responses

Successful response

Bodyapplication/json
run_idstring
job_idstring
plot_idstring
check_typestring
effective_configobject
statusstring
errorstring
analysis_imagestring
tokens_costinteger(int32)
created_atstring
updated_atstring
analysisobject(Analysis)

Complete analysis data for a plot

Response
application/json
{
  "run_id": "string",
  "job_id": "string",
  "plot_id": "string",
  "check_type": "string",
  "effective_config": {
    "property1": {},
    "property2": {}
  },
  "status": "string",
  "error": "string",
  "analysis_image": "string",
  "tokens_cost": 0,
  "created_at": "string",
  "updated_at": "string",
  "analysis": {
    "analysisEnd": "2024-02-29",
    "analysis_end": "2024-02-29",
    "risk_level": "Low",
    "forest_percentage_2020": 93.07,
    "indigenous_land": { … },
    "logging_area": 1.08,
    "forest_area_2020": 145.31,
    "risk_reason": "Low: Low deforestation detection",
    "version": "2024-11-13",
    "areaHa": 156.13,
    "protected_areas": { … },
    "deforestation": { … },
    "deforestation_percentage": 0.044,
    "protectedAreas": [ … ],
    "indigenous_overlap": { … }
  }
}

Create a new job

Request

Creates a new job based on the given list of plot_ids. Warning: This operation will consume user tokens

Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
X-Dry-Runboolean

Optional boolean. When true, runs the job in dry-run mode: skips token consumption and heavy compute and returns a simulated analysis with dummy visualization.

Example: true
Bodyapplication/jsonrequired

Details of the job to create

job_namestring

Name of the job

Example: "Planting season analysis for Q1"
plot_idsArray of stringsrequired

List of plot IDs that belong to the user to be analyzed in the job

Example: ["ef6f5727-307f-4e9d-abcb-74a8b6af0366","asd9632d-b589-4e05-9c8b-58fed1f9823a3"]
notesstring

Additional notes about the job

Example: "Analysis for initial planting"
additional_infoobject

Additional information about the job as key-value pairs, where keys and values are both strings

Example: {"soilQuality":"High","irrigationType":"Drip"}
checksArray of objects(JobCheckConfig)

Optional list of check definitions to run for this job. If omitted or empty, a single 'eudr' check is run by default. Currently only 'eudr' is supported; additional check types will be added in the future.

Example: [{"type":"eudr","config":{"harvest_date":"2024-11-01","commodity":"cocoa"},"per_plot":{"ef6f...0366":{"harvest_date":"2024-12-01"}}}]
curl -i -X POST \
  https://api.open-atlas.com/_mock/openapi/jobs/make_job \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature' \
  -H 'Content-Type: application/json' \
  -H 'X-Dry-Run: true' \
  -d '{
    "job_name": "Planting season analysis for Q1",
    "plot_ids": [
      "ef6f5727-307f-4e9d-abcb-74a8b6af0366",
      "asd9632d-b589-4e05-9c8b-58fed1f9823a3"
    ],
    "notes": "Analysis for initial planting",
    "additional_info": {
      "soilQuality": "High",
      "irrigationType": "Drip"
    },
    "checks": [
      {
        "type": "eudr",
        "config": {
          "harvest_date": "2024-11-01",
          "commodity": "cocoa"
        },
        "per_plot": {
          "ef6f...0366": {
            "harvest_date": "2024-12-01"
          }
        }
      }
    ]
  }'

Responses

Job created successfully and plots to be analyzed

Bodyapplication/json
usernamestring

Name of the user account that created and owns the job

Example: "abc_pro"
notesstring

Additional notes related to the plot

Example: "This plot requires frequent irrigation."
job_idstring

Unique identifier for the job

Example: "a31da612-fefe-4da8-800d-0e7120f5617e"
job_namestring

Name of the job

Example: "August shipment 827128"
plot_idsArray of strings

A list of IDs of plots to be analyzed in the job

Example: ["ef6f5727-307f-4e9d-abcb-74a8b6af0366","asd9632d-b589-4e05-9c8b-58fed1f9823a3"]
created_atstring(date-time)

Timestamp of job creation

updated_atstring(date-time)

Timestamp of job update, for example when the job's analysis is complete

additional_infoobject

Analysis data for the plot, represented as key-value pairs

Example: {"job_urgency":"high","reviewer":"employee A"}
token_costinteger(int32)

Amount of tokens the job costs based on the plots

Example: 8
statusstring

Current status of the job

Enum"creating""pending""incomplete""done-with-errors""done"
plotsArray of objects(Plot)

List of plots associated with the job

job_visualization_urlArray of strings

List of URLs for visualizations of analysis of plots associated with the job

Example: ["https://example.com/ef6f5727-307f-4e9d-abcb-74a8b6af0366.png","https://example.com/asd9632d-b589-4e05-9c8b-58fed1f9823a3.png"]
harvest_datestringDeprecated
Response
application/json
{
  "username": "abc_pro",
  "notes": "This plot requires frequent irrigation.",
  "job_id": "a31da612-fefe-4da8-800d-0e7120f5617e",
  "job_name": "August shipment 827128",
  "plot_ids": [
    "ef6f5727-307f-4e9d-abcb-74a8b6af0366",
    "asd9632d-b589-4e05-9c8b-58fed1f9823a3"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "additional_info": {
    "job_urgency": "high",
    "reviewer": "employee A"
  },
  "token_cost": 8,
  "harvest_date": "string",
  "status": "creating",
  "plots": [
    { … }
  ],
  "job_visualization_url": [
    "https://example.com/ef6f5727-307f-4e9d-abcb-74a8b6af0366.png",
    "https://example.com/asd9632d-b589-4e05-9c8b-58fed1f9823a3.png"
  ]
}

Retrieve job details

Request

Fetches details of a specific job by its unique job_id

Path
job_idstringrequired
Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
curl -i -X GET \
  'https://api.open-atlas.com/_mock/openapi/jobs/job/{job_id}' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature'

Responses

Job details retrieved successfully

Bodyapplication/json
usernamestring

Name of the user account that created and owns the job

Example: "abc_pro"
notesstring

Additional notes related to the plot

Example: "This plot requires frequent irrigation."
job_idstring

Unique identifier for the job

Example: "a31da612-fefe-4da8-800d-0e7120f5617e"
job_namestring

Name of the job

Example: "August shipment 827128"
plot_idsArray of strings

A list of IDs of plots to be analyzed in the job

Example: ["ef6f5727-307f-4e9d-abcb-74a8b6af0366","asd9632d-b589-4e05-9c8b-58fed1f9823a3"]
created_atstring(date-time)

Timestamp of job creation

updated_atstring(date-time)

Timestamp of job update, for example when the job's analysis is complete

additional_infoobject

Analysis data for the plot, represented as key-value pairs

Example: {"job_urgency":"high","reviewer":"employee A"}
token_costinteger(int32)

Amount of tokens the job costs based on the plots

Example: 8
statusstring

Current status of the job

Enum"creating""pending""incomplete""done-with-errors""done"
plotsArray of objects(Plot)

List of plots associated with the job

job_visualization_urlArray of strings

List of URLs for visualizations of analysis of plots associated with the job

Example: ["https://example.com/ef6f5727-307f-4e9d-abcb-74a8b6af0366.png","https://example.com/asd9632d-b589-4e05-9c8b-58fed1f9823a3.png"]
harvest_datestringDeprecated
Response
application/json
{
  "username": "abc_pro",
  "notes": "This plot requires frequent irrigation.",
  "job_id": "a31da612-fefe-4da8-800d-0e7120f5617e",
  "job_name": "August shipment 827128",
  "plot_ids": [
    "ef6f5727-307f-4e9d-abcb-74a8b6af0366",
    "asd9632d-b589-4e05-9c8b-58fed1f9823a3"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "additional_info": {
    "job_urgency": "high",
    "reviewer": "employee A"
  },
  "token_cost": 8,
  "harvest_date": "string",
  "status": "creating",
  "plots": [
    { … }
  ],
  "job_visualization_url": [
    "https://example.com/ef6f5727-307f-4e9d-abcb-74a8b6af0366.png",
    "https://example.com/asd9632d-b589-4e05-9c8b-58fed1f9823a3.png"
  ]
}

List user's jobs

Request

Returns the authenticated user's jobs with keyset pagination (newest first). Each job includes plot_ids and job_visualization_url (no embedded plot objects). The response includes a meta object with pagination info.

Query
limitinteger(int32)

Maximum number of items to return (default 100, max 1000)

Default 100
cursorstring

Opaque cursor for the next page

created_at_fromstring

Filter: inclusive lower bound for created_at (ISO-8601)

created_at_untilstring

Filter: inclusive upper bound for created_at (ISO-8601)

Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
curl -i -X GET \
  'https://api.open-atlas.com/_mock/openapi/jobs?limit=100&cursor=string&created_at_from=string&created_at_until=string' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature'

Responses

Successful response

Bodyapplication/json
jobsArray of objects(Job)

List of jobs

Example: [{"job_id":"a31da612-fefe-4da8-800d-0e7120f5617e","job_name":"August shipment 827128","plot_ids":["ef6f5727-307f-4e9d-abcb-74a8b6af0366","asd9632d-b589-4e05-9c8b-58fed1f9823a3"],"username":"abc_pro","created_at":"2024-09-04T18:18:01","updated_at":"2024-09-04T18:18:03","notes":"Initial batch run","additional_info":{"job_urgency":"high","reviewer":"employee A"},"token_cost":8,"status":"pending","job_visualization_url":["https://jobviz.s3.eu-central-1.amazonaws.com/path/to/plot1.png","https://jobviz.s3.eu-central-1.amazonaws.com/path/to/plot2.png"]}]
metaobject

Pagination metadata containing has_more, next_cursor, limit, and count

Example: {"next_cursor":"eyJsZWsiOiJZM0psWVhSbFpFRjBIbE02TWpBeU5TMHdOeTB6TVZReE56b3lNem8xTVI5d2JHOTBTV1FlVXpwak9EWTVaRFJsWlMwM09EZ3lMVFJoTjJFdFlqSmhaQzB4TWpkak1XRXlNemM0TjJNZmRYTmxjbTVoYldVZVV6cHZjR1Z1WVhSc1lYTmZiV0ZwYmciLCJ1Ijoib3BlbmF0bGFzX21haW4iLCJ2IjoxLCJleHAiOjE3NTYzMDc3OTY1MDgsImlhdCI6MTc1NjMwNTk5NjUwOH0.J1gFjyqEdHEmSYgaUVLH-YYePiBxNTc82LOXTowRjbA","limit":100,"count":100,"has_more":true}
Response
application/json
{
  "jobs": [
    { … }
  ],
  "meta": {
    "next_cursor": "eyJsZWsiOiJZM0psWVhSbFpFRjBIbE02TWpBeU5TMHdOeTB6TVZReE56b3lNem8xTVI5d2JHOTBTV1FlVXpwak9EWTVaRFJsWlMwM09EZ3lMVFJoTjJFdFlqSmhaQzB4TWpkak1XRXlNemM0TjJNZmRYTmxjbTVoYldVZVV6cHZjR1Z1WVhSc1lYTmZiV0ZwYmciLCJ1Ijoib3BlbmF0bGFzX21haW4iLCJ2IjoxLCJleHAiOjE3NTYzMDc3OTY1MDgsImlhdCI6MTc1NjMwNTk5NjUwOH0.J1gFjyqEdHEmSYgaUVLH-YYePiBxNTc82LOXTowRjbA",
    "limit": 100,
    "count": 100,
    "has_more": true
  }
}

Get token balance info

Request

Retrieves the total token balance, reserved tokens, and free tokens for the user associated with the provided Bearer token.

Headers
Authorizationstring

Authorization header with a Bearer token, formatted as 'Bearer [JWT]' where [JWT] is the JSON Web Token used for user authentication and authorization.

Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature
curl -i -X GET \
  https://api.open-atlas.com/_mock/openapi/users/check_tokens \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.your-payload-here.signature'

Responses

Token balance details retrieved successfully

Bodyapplication/json
string
Response
application/json
{
  "token_balance": 100,
  "reserved_tokens": 22,
  "free_tokens": 78
}

Protected Areas

Operations