Create

Create New Project

Create new project

post

/{app_id}/projects/create

Authorizations

OAuth2AuthorizationCodeBearerAPIKeyHeaderAPIKeyQuery

Path parameters

app_idintegerrequired

Body

namestringrequired

Project name

descriptionany of

Project description

creation_strategyany of

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

publicany of · default: false

Project publication setting

reportany of

Settings for an optionally created report

area_of_interestany ofrequired

GeoJSON feature describing the area of interest

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v2/{app_id}/projects/create' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "Project description",
    "name": "Project name",
    "public": true,
    "area_of_interest": {
      "properties": {
        "radius": 0.133
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -78.84779139647071,
          -4.0988921451725275
        ]
      }
    }
  }'

200

422

200

{
  "description": "Project description",
  "id": 123,
  "name": "Project name",
  "area_of_interest": {
    "properties": {
      "radius": 0.133
    },
    "geometry": {
      "type": "Point",
      "coordinates": [
        -78.84779139647071,
        -4.0988921451725275
      ]
    }
  }
}

Successful Response