Create

Create New Project

Create new project

POST/api/v2/{app_id}/projects/create

Authorization

Path parameters

app_id*App Id

Body

name*Name

Project name

descriptionDescription

Project description

creation_strategyCreation Strategy

Used in case multiple polygons are present. Can be either MERGE or FIRST. Defaults to first

publicPublic

Project publication setting

area_of_interest*Area Of Interest

GeoJSON feature describing the area of interest

reportany of

Settings for an optionally created report

Response

Successful Response

Body

id*Id

Project id

name*Name

Project name

descriptionDescription

Project description

public*Public

Project publication setting

area_of_interest*all of

GeoJSON feature describing the area of interest

reportany of

Optionally created report

Request

const response = await fetch('/api/v2/{app_id}/projects/create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "area_of_interest": {
        "geometry": {
          "type": "text",
          "coordinates": [
            0
          ]
        }
      }
    }),
});
const data = await response.json();

Response

{
  "name": "text",
  "description": "text",
  "public": false,
  "area_of_interest": {
    "geometry": {
      "type": "text",
      "coordinates": [
        0
      ]
    },
    "id": "text",
    "bbox": []
  },
  "report": {
    "title": "text",
    "description": "text",
    "public_report_dashboard_url": "text",
    "private_report_dashboard_url": "text",
    "inputs": {
      "start_date": "2024-11-21",
      "end_date": "2024-11-21"
    },
    "refresh_frequency": "monthly",
    "status": {},
    "components": [
      {
        "status": {},
        "report_component_type": "text",
        "error": {
          "error": "text"
        }
      }
    ]
  }
}

PreviousProjects Next/

const response = await fetch('/api/v2/{app_id}/projects/create', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "area_of_interest": { "geometry": { "type": "text", "coordinates": [ 0 ] } } }), }); const data = await response.json();

{ "name": "text", "description": "text", "public": false, "area_of_interest": { "geometry": { "type": "text", "coordinates": [ 0 ] }, "id": "text", "bbox": [] }, "report": { "title": "text", "description": "text", "public_report_dashboard_url": "text", "private_report_dashboard_url": "text", "inputs": { "start_date": "2024-11-21", "end_date": "2024-11-21" }, "refresh_frequency": "monthly", "status": {}, "components": [ { "status": {}, "report_component_type": "text", "error": { "error": "text" } } ] } }