Submit tasking order

post

Creates a tasking order for a new capture request. The area of interest can be provided as H3 zones or a GeoJSON polygon, and each requested product is tracked independently.

Authorizations

x-api-keystringRequired

API key passed via request header. Either this or the api_key query parameter is required.

Body

zonesstring[] · min: 1Optional

Area of interest expressed as a list of H3 cell identifiers. Provide this OR geometry, never both. Must contain at least one zone.

Example: ["8928308280fffff","89283082803ffff"]

intentstring · enumRequired

Purpose of the order. Currently only new_capture (request a fresh capture of the area) is supported.

Possible values:

customer_org_namestring · min: 1Required

Name of the customer organization placing the order.

Example: Acme Surveying

customer_first_namestring · min: 1Required

First name of the primary customer contact.

Example: Jane

customer_last_namestring · min: 1Required

Last name of the primary customer contact.

Example: Doe

customer_emailstring · emailRequired

Email address of the primary customer contact.

Example: [e-mail]

preferred_capture_startstring · date-timeOptional

Preferred start of the capture window (ISO-8601). When both bounds are supplied, must be before preferred_capture_end.

Example: 2026-07-01T00:00:00.000Z

preferred_capture_endstring · date-timeOptional

Preferred end of the capture window (ISO-8601). When both bounds are supplied, must be after preferred_capture_start.

Example: 2026-07-31T00:00:00.000Z

external_order_idstringOptional

Caller-supplied identifier for the order in an external system. Echoed back on read endpoints for reconciliation.

Example: PO-2026-0042

control_data_urlstring · uriOptional

URL to ground control or reference data to use for this capture.

notesstringOptional

Free-form notes or special instructions for the order.

Responses

201

Tasking order accepted and persisted.

application/json

spexi_order_idstringRequired

Spexi-assigned identifier for the newly created order.

Example: SPX-20260625-ABC123

submitted_by_org_idstring · uuidRequired

UUID of the organization that submitted the order.

external_order_idstringOptional

Echoed external_order_id from the request, if one was sent.

control_data_urlstring · uriOptional

Echoed control_data_url from the request, if one was sent.

statusstring · enumRequired

Initial order status. Always submitted on creation.

Possible values:

created_atstring · date-timeRequired

ISO-8601 timestamp when the order was created.

400

Invalid payload: failed validation, both/neither of zones and geometry supplied, missing product_sub_type for an orthomosaic, or preferred_capture_start not before preferred_capture_end.

401

Missing or invalid authentication credentials.

403

Caller lacks permission to submit orders. Only org_owner and org_admin roles (or a Developer API key) may submit.

post/developer-api/api/v1/order/tasking

POST /developer-api/api/v1/order/tasking HTTP/1.1
Host: world.spexi.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 601

{
  "zones": [
    "8928308280fffff",
    "89283082803ffff"
  ],
  "geometry": {
    "type": "Feature",
    "geometry": {
      "type": "Polygon",
      "coordinates": [
        []
      ]
    },
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "intent": "new_capture",
  "products": [
    {
      "product_type": "panorama",
      "product_sub_type": "standard"
    }
  ],
  "customer_org_name": "Acme Surveying",
  "customer_first_name": "Jane",
  "customer_last_name": "Doe",
  "customer_email": "[e-mail]",
  "preferred_capture_start": "2026-07-01T00:00:00.000Z",
  "preferred_capture_end": "2026-07-31T00:00:00.000Z",
  "external_order_id": "PO-2026-0042",
  "control_data_url": "https://example.com",
  "notes": "text"
}

{
  "spexi_order_id": "SPX-20260625-ABC123",
  "submitted_by_org_id": "123e4567-e89b-12d3-a456-426614174000",
  "external_order_id": "text",
  "control_data_url": "https://example.com",
  "status": "submitted",
  "created_at": "2026-01-01T00:00:00.000Z"
}