--- updatedAt: 2026-06-08T20:33:08.000Z agentTools: projectIndex: https://docs.canopy.umbra.space/llms.txt --- # Get Collect # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Tasking", "description": "Canopy API for Self-Service Tasking", "version": "3.23.0" }, "servers": [ { "url": "https://api.canopy.umbra.space/tasking", "description": "Live Environment" }, { "url": "https://api.canopy.prod.umbra-sandbox.space/tasking", "description": "Sandbox Environment" } ], "paths": { "/collects/{id}": { "get": { "tags": [ "Collects" ], "summary": "Get Collect", "operationId": "get_collect", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "CollectResponse": { "properties": { "type": { "type": "string", "title": "Type", "default": "Feature" }, "geometry": { "oneOf": [ { "$ref": "#/components/schemas/Point" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "$ref": "#/components/schemas/GeometryCollection-Output" } ], "title": "Geometry", "discriminator": { "propertyName": "type", "mapping": { "GeometryCollection": "#/components/schemas/GeometryCollection-Output", "LineString": "#/components/schemas/LineString", "MultiLineString": "#/components/schemas/MultiLineString", "MultiPoint": "#/components/schemas/MultiPoint", "MultiPolygon": "#/components/schemas/MultiPolygon", "Point": "#/components/schemas/Point", "Polygon": "#/components/schemas/Polygon" } } }, "archiveIds": { "items": { "type": "string", "format": "uuid" }, "type": "array", "title": "Archiveids" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "properties": { "$ref": "#/components/schemas/CollectResponseProperties" } }, "type": "object", "required": [ "geometry", "id", "properties" ], "title": "CollectResponse", "description": "Read only Collect model for responses" }, "CollectResponseProperties": { "properties": { "id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "integer" }, { "type": "string" } ], "title": "Id" }, "createdAt": { "type": "string", "format": "date-time", "title": "Createdat" }, "updatedAt": { "type": "string", "format": "date-time", "title": "Updatedat" }, "collectName": { "type": "string", "title": "Collectname", "description": "Name for the collect, in the form of the vehicle the collect is tasked on - start date and time of the collect" }, "taskId": { "type": "string", "format": "uuid", "title": "Taskid", "description": "Maps to tasks, tasks may have more than one collect associated with it based on the type of task (e.g. mosaic or recurring types)" }, "satelliteId": { "type": "string", "title": "Satelliteid", "description": "Vehicle to satisfy collect" }, "collectType": { "$ref": "#/components/schemas/CollectType", "description": "Imaging mode used for collect, e.g. 'SPOTLIGHT'", "default": "SPOTLIGHT" }, "status": { "$ref": "#/components/schemas/CollectStatus", "description": "Current status of collect" }, "statusHistory": { "items": { "$ref": "#/components/schemas/CollectStatusEvent" }, "type": "array", "title": "Statushistory", "description": "The status history of the collect" }, "startAt": { "type": "string", "format": "date-time", "title": "Startat", "description": "Approximate time to start collect" }, "endAt": { "type": "string", "format": "date-time", "title": "Endat", "description": "Approximate time to end collect" }, "footprintSquareMeters": { "type": "number", "title": "Footprintsquaremeters", "description": "Area in square meters of the collect geometry" }, "targetAzimuthAngleDegrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Targetazimuthangledegrees", "description": "The Target Azimuth angle is measured clockwise from north as measured at the target location. Approximate until the collect is CollectStatus.PROCESSED" }, "grazingAngleDegrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Grazingangledegrees", "description": "The Grazing Angle is the angle between the local tangent plane at the target location and the line of sight vector between the satellite and the target. Approximate until the collect is CollectStatus.PROCESSED" }, "incidenceAngleDegrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Incidenceangledegrees", "description": "The Incidence Angle is 90° - Grazing Angle. Approximate until the collect is CollectStatus.PROCESSED" }, "squintAngleEngineeringDegrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Squintangleengineeringdegrees", "description": "\"Squinted\" refers to how far away from broadside the angle is. Since exactly broadside is either 90 or -90 degrees, the proximity of the angle to 0 degrees suggests the satellite is further “squinted” forward for collection. In contrast, closeness to 180 or -180 degrees indicates being further “squinted” backward. Approximate until the collect is CollectStatus.PROCESSED. Learn more at: https://docs.canopy.umbra.space/docs/squint" }, "squintAngleDegrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Squintangledegrees", "description": "The Squint Angle is measured in the local horizontal plane at the satellite location and has the range (-180, 180]. It is the angle between 90° clockwise the direction of travel of the asset and the projection of the line of sight vector into this plane. Approximate until the collect is CollectStatus.PROCESSED. Note that this field will soon be DEPRECATED. Please use squintAngleEngineeringDegrees. Read more at: https://docs.canopy.umbra.space/docs/squint" }, "squintAngleExploitationDegrees": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Squintangleexploitationdegrees", "description": "Earth surface angle between the cross-track vector and the ground range arc. Learn more at: https://docs.canopy.umbra.space/docs/squint" }, "squintAngleDegreesOffBroadside": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Squintangledegreesoffbroadside", "description": "Calculated looking at the squint angle relative to its nearest broadside value (-90 or 90 degrees) and computing the difference, yielding the \"degrees off broadside\" value. Learn more at: https://docs.canopy.umbra.space/docs/squint" }, "slantRangeKilometers": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Slantrangekilometers", "description": "The Slant Range is the straight line distance between the target location and the satellite. Approximate until the collect is CollectStatus.PROCESSED" }, "polarization": { "anyOf": [ { "$ref": "#/components/schemas/PolarizationEnum" }, { "type": "null" } ], "description": "Polarization refers to the orientation of the wave as it is transmitted or how it is filtered upon receive." }, "azimuthResolutionMinMeters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Azimuthresolutionminmeters", "description": "Minimum azimuth resolution in processed images" }, "rangeResolutionMinMeters": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rangeresolutionminmeters", "description": "Minimum range resolution in processed images" }, "multilookFactor": { "type": "integer", "title": "Multilookfactor", "description": "Azimuth looks", "default": 1 }, "organizationId": { "type": "string", "title": "Organizationid", "description": "Collect Organization ID" }, "taskName": { "type": "string", "title": "Taskname", "description": "Name of the task for this collect", "default": "" }, "taskType": { "$ref": "#/components/schemas/TaskType", "description": "Type of task associated with this collect" }, "userOrderId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Userorderid", "description": "User order ID associated with the task for this collect" } }, "type": "object", "required": [ "id", "collectName", "taskId", "satelliteId", "status", "startAt", "endAt", "footprintSquareMeters", "organizationId", "taskType" ], "title": "CollectResponseProperties" }, "CollectStatus": { "type": "string", "enum": [ "ACTIVE", "SCHEDULED", "COMMANDED", "COLLECTED", "DOWNLINKED", "INCOMPLETE", "CORRUPT", "STAGED", "QUEUED", "PROCESSING", "PROCESSING_DELAY", "PROCESSED", "SUPERSEDED", "FAILED", "CANCELED", "STALLED", "UNKNOWN_COLLECT_STATUS", "PARSED", "ASSEMBLED", "TRANSMITTED", "DELIVERED", "DELIVERING", "DELIVERY_STALLED", "DELIVERY_DELAYED", "DELIVERY_ERROR" ], "title": "Collect Status", "description": "See https://docs.canopy.umbra.space/docs/tasking#collect-status for details." }, "CollectStatusEvent": { "properties": { "timestamp": { "type": "string", "format": "date-time", "title": "Timestamp" }, "status": { "$ref": "#/components/schemas/CollectStatus" }, "message": { "type": "string", "title": "Message", "default": "" } }, "type": "object", "required": [ "timestamp", "status" ], "title": "CollectStatusEvent" }, "CollectType": { "type": "string", "enum": [ "SPOTLIGHT", "CUSTOM", "DYNAMIC_STRIPMAP" ], "title": "Collect Type", "description": "The Collect Type. This generally maps to Task.ImagingMode." }, "GeometryCollection-Output": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "title": "Type" }, "geometries": { "items": { "oneOf": [ { "$ref": "#/components/schemas/Point" }, { "$ref": "#/components/schemas/MultiPoint" }, { "$ref": "#/components/schemas/LineString" }, { "$ref": "#/components/schemas/MultiLineString" }, { "$ref": "#/components/schemas/Polygon" }, { "$ref": "#/components/schemas/MultiPolygon" }, { "$ref": "#/components/schemas/GeometryCollection-Output" } ], "discriminator": { "propertyName": "type", "mapping": { "GeometryCollection": "#/components/schemas/GeometryCollection-Output", "LineString": "#/components/schemas/LineString", "MultiLineString": "#/components/schemas/MultiLineString", "MultiPoint": "#/components/schemas/MultiPoint", "MultiPolygon": "#/components/schemas/MultiPolygon", "Point": "#/components/schemas/Point", "Polygon": "#/components/schemas/Polygon" } } }, "type": "array", "title": "Geometries" } }, "type": "object", "required": [ "type", "geometries" ], "title": "GeometryCollection", "description": "GeometryCollection Model" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "LineString": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "title": "Type", "default": "LineString" }, "coordinates": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "minItems": 2, "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "LineString", "description": "LineString Model" }, "MultiLineString": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "title": "Type", "default": "MultiLineString" }, "coordinates": { "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "minItems": 2 }, "type": "array", "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "MultiLineString", "description": "MultiLineString Model" }, "MultiPoint": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "title": "Type", "default": "MultiPoint" }, "coordinates": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "MultiPoint", "description": "MultiPoint Model" }, "MultiPolygon": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "title": "Type", "default": "MultiPolygon" }, "coordinates": { "items": { "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "minItems": 4 }, "type": "array" }, "type": "array", "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "MultiPolygon", "description": "MultiPolygon Model" }, "Point": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "title": "Type", "default": "Point" }, "coordinates": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ], "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "Point", "description": "Point Model" }, "PolarizationEnum": { "type": "string", "enum": [ "VV", "HH" ], "title": "Polarization", "description": "The first letter indicates the orientation of the wave as it is transmitted. The second letter indicates how the wave is filtered when received." }, "Polygon": { "properties": { "bbox": { "anyOf": [ { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 4, "minItems": 4 }, { "prefixItems": [ { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" }, { "type": "number" } ], "type": "array", "maxItems": 6, "minItems": 6 }, { "type": "null" } ], "title": "Bbox" }, "type": { "type": "string", "title": "Type", "default": "Polygon" }, "coordinates": { "items": { "items": { "anyOf": [ { "$ref": "#/components/schemas/Position2D" }, { "$ref": "#/components/schemas/Position3D" } ] }, "type": "array", "minItems": 4 }, "type": "array", "title": "Coordinates" } }, "type": "object", "required": [ "type", "coordinates" ], "title": "Polygon", "description": "Polygon Model" }, "Position2D": { "prefixItems": [ { "type": "number", "title": "Longitude" }, { "type": "number", "title": "Latitude" } ], "type": "array", "maxItems": 2, "minItems": 2 }, "Position3D": { "prefixItems": [ { "type": "number", "title": "Longitude" }, { "type": "number", "title": "Latitude" }, { "type": "number", "title": "Altitude" } ], "type": "array", "maxItems": 3, "minItems": 3 }, "TaskType": { "type": "string", "enum": [ "STANDARD", "ARCHIVE" ], "title": "TaskType", "description": "TaskType" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "bearerAuth": [] } ] } ```