openapi: 3.0.0
info:
  title: Leaf Agriculture Leaf API Reference > Alerts API Reference > Crop Monitoring API
  description: We are Leaf Agriculture, provider of a unified farm data API. After experiencing the difficulty of building applications in food and agriculture first hand as software developers, and hearing similar stories of frustration with existing tools and often insurmountable technical barriers from other companies, we decided to tackle the problem at hand.
  version: 1.0.0
tags:
- name: API Reference > Crop Monitoring
paths:
  /services/satellite/api/fields:
    get:
      tags:
      - API Reference > Crop Monitoring
      summary: Leaf Agriculture Get all satellite fields
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Authorization
        in: header
        schema:
          type: string
        example: Bearer {{leaf_token}}
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    post:
      tags:
      - API Reference > Crop Monitoring
      summary: Leaf Agriculture Create a satellite field
      requestBody:
        content:
          '*/*':
            schema:
              type: string
              example: '"{\n  \"assetTypes\": [\n    \"ortho_analytic_8b_sr\"\n  ],\n  \"externalId\": \"{{sat_external_id}}\",\n  \"daysBefore\": 30,\n  \"geometry\": {\n    \"type\": \"MultiPolygon\",\n    \"coordinates\": [\n      [\n        [\n          [\n            -48.95275447,\n            -22.49608\n          ],\n          [\n            -48.95379286,\n            -22.49675703\n          ],\n          [\n            -48.9591836,\n            -22.50310243\n          ],\n          [\n            -48.96225525,\n            -22.5067235\n          ],\n          [\n            -48.94852019,\n            -22.50648371\n          ],\n          [\n            -48.94780839,\n            -22.49693998\n          ],\n          [\n            -48.95275447,\n            -22.49608\n          ]\n        ]\n      ]\n    ]\n  },\n  \"providers\": [\n    \"planet\"\n  ]\n}"'
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Authorization
        in: header
        schema:
          type: string
        example: Bearer {{leaf_token}}
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /services/satellite/api/fields/{sat_external_id}/processes:
    get:
      tags:
      - API Reference > Crop Monitoring
      summary: Leaf Agriculture Get images of satellite field
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Authorization
        in: header
        schema:
          type: string
        example: Bearer {{leaf_token}}
      - name: sat_external_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /services/satellite/api/fields/{sat_external_id}:
    get:
      tags:
      - API Reference > Crop Monitoring
      summary: Leaf Agriculture Get a satellite field
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Authorization
        in: header
        schema:
          type: string
        example: Bearer {{leaf_token}}
      - name: sat_external_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
    delete:
      tags:
      - API Reference > Crop Monitoring
      summary: Leaf Agriculture Delete a satellite field
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Authorization
        in: header
        schema:
          type: string
        example: Bearer {{leaf_token}}
      - name: sat_external_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /services/satellite/api/fields/{sat_external_id}/processes/{process_id}:
    get:
      tags:
      - API Reference > Crop Monitoring
      summary: Leaf Agriculture Get an image of satellite field
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Authorization
        in: header
        schema:
          type: string
        example: Bearer {{leaf_token}}
      - name: sat_external_id
        in: path
        schema:
          type: string
        required: true
      - name: process_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /services/satellite/api/fields/{sat_external_id}/subscription:
    get:
      tags:
      - API Reference > Crop Monitoring
      summary: Leaf Agriculture Get subscription for Planet
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Authorization
        in: header
        schema:
          type: string
        example: Bearer {{leaf_token}}
      - name: sat_external_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}
  /services/satellite/api/fields/{sat_external_id}/processes/{process_id}/reprocess:
    post:
      tags:
      - API Reference > Crop Monitoring
      summary: Leaf Agriculture Reprocess satellite images
      requestBody:
        content: {}
      parameters:
      - name: Content-Type
        in: header
        schema:
          type: string
        example: application/json
      - name: Authorization
        in: header
        schema:
          type: string
        example: Bearer {{leaf_token}}
      - name: sat_external_id
        in: path
        schema:
          type: string
        required: true
      - name: process_id
        in: path
        schema:
          type: string
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json: {}