# Create a new job

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

Endpoint: POST /jobs/make_job
Version: 3.0.1

## Header parameters:

  - `Authorization` (string)
    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-Run` (boolean)
    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

## Request fields (application/json):

  - `job_name` (string)
    Name of the job
    Example: "Planting season analysis for Q1"

  - `plot_ids` (array, required)
    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"]

  - `notes` (string)
    Additional notes about the job
    Example: "Analysis for initial planting"

  - `additional_info` (object)
    Additional information about the job as key-value pairs, where keys and values are both strings
    Example: {"soilQuality":"High","irrigationType":"Drip"}

  - `checks` (array)
    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"}}}]

  - `checks.type` (string)
    Check type to run. For now only 'eudr' check is supported. Use the string value 'eudr'.
    Enum: "eudr", "protected-area", "indigenous-land"

  - `checks.config` (object)
    Optional check-level configuration. Only needed when required fields are missing from plot registration.
For EUDR, provide 'harvest_date' and/or 'commodity' if they were not set on the plot. If they were set they will be overriden by config here.
    Example: {"harvest_date":"2024-11-01","commodity":"cocoa"}

  - `checks.per_plot` (object)
    Per-plot overrides keyed by plot_id. Values override entries from 'config' for that specific plot.
Global 'config' applies to all plots unless a plot has an entry here, in which case the per_plot entry takes precedence.
    Example: {"ef6f5727-377f-4e9d-abcb-74a8a6bf0366":{"harvest_date":"2024-12-01"}}

## Response 200 fields (application/json):

  - `username` (string)
    Name of the user account that created and owns the job
    Example: "abc_pro"

  - `notes` (string)
    Additional notes related to the plot
    Example: "This plot requires frequent irrigation."

  - `job_id` (string)
    Unique identifier for the job
    Example: "a31da612-fefe-4da8-800d-0e7120f5617e"

  - `job_name` (string)
    Name of the job
    Example: "August shipment 827128"

  - `plot_ids` (array)
    A list of IDs of plots to be analyzed in the job
    Example: ["ef6f5727-307f-4e9d-abcb-74a8b6af0366","asd9632d-b589-4e05-9c8b-58fed1f9823a3"]

  - `created_at` (string)
    Timestamp of job creation

  - `updated_at` (string)
    Timestamp of job update, for example when the job's analysis is complete

  - `additional_info` (object)
    Analysis data for the plot, represented as key-value pairs
    Example: {"job_urgency":"high","reviewer":"employee A"}

  - `token_cost` (integer)
    Amount of tokens the job costs based on the plots
    Example: 8

  - `status` (string)
    Current status of the job
    Enum: "creating", "pending", "incomplete", "done-with-errors", "done"

  - `plots` (array)
    List of plots associated with the job

  - `plots.username` (string)
    Username of the account that created the plot, the plot owner
    Example: "jdoe"

  - `plots.country` (string)
    Country where the plot is located
    Example: "United States"

  - `plots.state` (string)
    State or region where the plot is located
    Example: "California"

  - `plots.analysis` (object)
    Complete analysis data for a plot

  - `plots.analysis.analysisEnd` (string)
    End date of the analysis
    Example: "2024-02-29"

  - `plots.analysis.analysis_end` (string)
    End date of the analysis
    Example: "2024-02-29"

  - `plots.analysis.risk_level` (string)
    Risk level assessment
    Example: "Low"

  - `plots.analysis.forest_percentage_2020` (number)
    Forest percentage in 2020
    Example: 93.07

  - `plots.analysis.indigenous_land` (object)
    Analysis of indigenous lands overlapping with a plot

  - `plots.analysis.indigenous_land.indigenous_land_overlap_summary` (object)
    Summary of indigenous land overlap with plot

  - `plots.analysis.indigenous_land.indigenous_land_overlap_summary.indigenous_land_overlap` (boolean, required)
    Indicates if the plot overlaps with any indigenous land

  - `plots.analysis.indigenous_land.indigenous_land_overlap_summary.total_overlap_percentage` (number)
    Percentage of plot area that overlaps with indigenous land
    Example: 25.3

  - `plots.analysis.indigenous_land.indigenous_land_overlap_summary.total_overlap_area_ha` (number)
    Plot area (in hectares) that overlaps with indigenous land
    Example: 155.3

  - `plots.analysis.indigenous_land.indigenous_land_details` (array)
    Detailed information about each overlapping indigenous land

  - `plots.analysis.indigenous_land.indigenous_land_details.id` (string, required)
    Unique identifier of the indigenous land
    Example: "IL-202"

  - `plots.analysis.indigenous_land.indigenous_land_details.name` (string)
    Name of the indigenous land
    Example: "Yanomami Territory"

  - `plots.analysis.indigenous_land.indigenous_land_details.government_acknowledged` (boolean)
    Acknowledgment of government
    Example: true

  - `plots.analysis.indigenous_land.indigenous_land_details.overlap_area_ha` (number)
    Overlap area in hectares
    Example: 3.1

  - `plots.analysis.indigenous_land.indigenous_land_details.land_status` (string)
    Status of the land, e.g. 'Community'
    Example: "Community"

  - `plots.analysis.indigenous_land.sources` (array)
    Sources of indigenous land data

  - `plots.analysis.indigenous_land.sources.source_name` (string, required)
    Name of the data source
    Example: "CNUC"

  - `plots.analysis.indigenous_land.sources.data_version` (string)
    Version or date of the data
    Example: "2024-11-20"

  - `plots.analysis.logging_area` (number)
    Logging area in hectares
    Example: 1.08

  - `plots.analysis.forest_area_2020` (number)
    Forest area in 2020 in hectares
    Example: 145.31

  - `plots.analysis.risk_reason` (string)
    Reason for risk assessment
    Example: "Low: Low deforestation detection"

  - `plots.analysis.version` (string)
    Version of the analysis
    Example: "2024-11-13"

  - `plots.analysis.areaHa` (number)
    Total area in hectares
    Example: 156.13

  - `plots.analysis.protected_areas` (object)
    Analysis of protected areas overlapping with a plot

  - `plots.analysis.protected_areas.protected_area_overlap_summary` (object)
    Summary of protected area overlap with plot

  - `plots.analysis.protected_areas.protected_area_overlap_summary.protected_area_overlap` (boolean, required)
    Indicates if the plot overlaps with any protected area

  - `plots.analysis.protected_areas.protected_area_overlap_summary.total_overlap_percentage` (number)
    Percentage of plot area that overlaps with protected areas
    Example: 25.3

  - `plots.analysis.protected_areas.protected_area_overlap_summary.total_overlap_area_ha` (number)
    Plot area (in hectares) that overlaps with protected areas
    Example: 155.3

  - `plots.analysis.protected_areas.protected_area_overlap_summary.most_restrictive_extractive_activity_legality` (string)
    Legality status of the most restrictive extractive activities of all the extractive activities returned with the protected areas
    Example: "prohibited"

  - `plots.analysis.protected_areas.protected_area_details` (array)
    Detailed information about each overlapping protected area

  - `plots.analysis.protected_areas.protected_area_details.area_id` (string, required)
    Unique identifier of the protected area
    Example: "37514"

  - `plots.analysis.protected_areas.protected_area_details.area_name` (string)
    Name of the protected area
    Example: "Cordillera Beata"

  - `plots.analysis.protected_areas.protected_area_details.local_name` (string)
    Local name of the protected area
    Example: "Cordillera Beata"

  - `plots.analysis.protected_areas.protected_area_details.source_name` (string)
    Source/authority providing the protected area data
    Example: "Parques Nacionales Naturales de Colombia"

  - `plots.analysis.protected_areas.protected_area_details.iucn_category` (string)
    IUCN protected area category
    Enum: "Ia", "Ib", "II", "III", "IV", "V", "VI"

  - `plots.analysis.protected_areas.protected_area_details.overlap_area_ha` (number)
    Area of overlap in hectares
    Example: 2208.6384

  - `plots.analysis.protected_areas.protected_area_details.extractive_activity_legality` (string)
    Legality status of extractive activities within the protected area
    Example: "limited"

  - `plots.analysis.protected_areas.protected_area_details.extractive_activity_conditions` (string)
    Conditions or notes describing what extractive activities are permitted
    Example: "Activities permitted: Research, education, and eco-tourism."

  - `plots.analysis.protected_areas.protected_area_details.regulation_names` (array)
    Names/titles of applicable regulations
    Example: ["DECRETO 622 DE MARZO 16 DE 1977","LEY 99 DE 1993"]

  - `plots.analysis.protected_areas.protected_area_details.regulation_urls` (array)
    URLs linking to applicable regulations
    Example: ["https://old.parquesnacionales.gov.co/portal/wp-content/uploads/2018/07/Decreto_622_de_1977.pdf","https://www.minambiente.gov.co/wp-content/uploads/2021/08/ley-99-1993.pdf","https://www.funcionpublica.gov.co/eva/gestornormativo/norma.php"]

  - `plots.analysis.protected_areas.protected_area_details.type` (string)
    Type/classification of the protected area
    Example: "Reserva Natural"

  - `plots.analysis.protected_areas.sources` (array)
    Sources of protected area data

  - `plots.analysis.deforestation` (object)
    Deforestation data for a plot

  - `plots.analysis.deforestation.total_yearly` (object)
    Total yearly deforestation data

  - `plots.analysis.deforestation.total_yearly_jrc` (object)
    Total yearly JRC deforestation data

  - `plots.analysis.deforestation.total` (number)
    Total deforestation
    Example: 0.069

  - `plots.analysis.deforestation.total_jrc` (number)
    Total JRC deforestation
    Example: 0.069

  - `plots.analysis.deforestation_percentage` (number)
    Deforestation percentage
    Example: 0.044

  - `plots.analysis.protectedAreas` (array)
    List of protected area names and their overlap areas in hectares
    Example: [["Área De Proteção Ambiental",0.24],["Rio Negro",156.13]]

  - `plots.analysis.indigenous_overlap` (object)
    Indigenous territories overlap analysis

  - `plots.analysis.indigenous_overlap.total_overlap_area` (number)
    Total area of overlap with indigenous territories in hectares
    Example: 150.5

  - `plots.analysis.indigenous_overlap.overlapping_territories` (array)
    List of overlapping indigenous territories

  - `plots.analysis.indigenous_overlap.overlap_percentage` (number)
    Percentage of overlap with indigenous territories
    Example: 25.5

  - `plots.plot_id` (string)
    Unique identifier for the plot
    Example: "ef6f5727-377f-4e9d-abcb-74a8a6bf0366"

  - `plots.plot_name` (string)
    Name of the plot
    Example: "East Field"

  - `plots.geojson_features` (array)

  - `plots.geojson_features.geometry` (any, required)
    Geometry object defining the spatial aspect of the feature, can be either Point or Polygon

  - `plots.geojson_features.properties` (object)
    Additional properties for the feature as key-value pairs. Optional properties include point_ha (float < 4.0)
    Example: {"point_ha":3.5}

  - `plots.geojson_features.type` (string, required)
    Type of the GeoJSON feature
    Example: "Feature"

  - `plots.harvest_dates` (array)
    Example: ["2024-11-01"]

  - `plots.commodity` (string)
    Type of commodity planted in the plot to do analysis on
    Enum: "wood", "soy", "cocoa", "coffee", "palm_oil", "beef", "rubber"

  - `plots.lat` (string)
    Latitude of the plot's center
    Example: "34.052235"

  - `plots.lon` (string)
    Longitude of the plot's center
    Example: "-118.243683"

  - `plots.area_ha` (number)
    Area of the plot in hectares
    Example: 12.5

  - `plots.tokens_cost` (integer)
    Cost of the analyzing the plot in tokens
    Example: 150

  - `plots.created_at` (string)
    Timestamp of plot creation

  - `plots.updated_at` (string)
    Timestamp of the last plot update

  - `plots.analysis_image` (string)
    URL for the visualization of the analysis of the plot
    Example: "https://example.com/images/plot-analysis.jpg"

  - `plots.additional_info` (object)
    Additional information about the plot as key-value pairs
    Example: {"soil_quality":"high","access":"restricted"}

  - `job_visualization_url` (array)
    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_date` (string)


## Response 400 fields

## Response 500 fields