{ "openapi": "3.0.0", "info": { "description": "Swagger doc for Stargate", "title": "stargate", "contact": { "name": "Team-Identity", "email": "identity@pixxel.co.in" }, "version": "v0.1.0" }, "paths": { "/ping": { "get": { "description": "Returns a pong message.", "tags": [ "external" ], "summary": "Ping Server", "responses": { "200": { "description": "Successful ping", "content": { "application/json": { "schema": { "type": "string" } } } } } } }, "/v0/projects": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List projects for the service user", "tags": [ "Project" ], "summary": "List projects", "operationId": "ListProjects", "parameters": [ { "description": "Page number", "name": "page_num", "in": "query", "schema": { "type": "integer" } }, { "description": "Page size", "name": "page_size", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/frontier.listProjects" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/projects/list-get-projects" } } }, "/v0/projects/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get project by ID. Only the projects under current service user will be accessible.", "tags": [ "Project" ], "summary": "Get project", "operationId": "GetProjectById", "parameters": [ { "description": "Project ID", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/frontier.getProjectById" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/projects/list-get-projects" } } }, "/v0/aois": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List all Areas of Interest (AOIs) with optional filtering", "tags": [ "AOI" ], "summary": "List all AOIs", "operationId": "ListAOIs", "parameters": [ { "description": "Offset for pagination", "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } }, { "description": "Limit for pagination", "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 } }, { "description": "Filter by creation date", "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by update date", "name": "updated_at", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by AOI ID", "name": "aoi_id", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by AOI name", "name": "aoi_name", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by project IDs (comma separated)", "name": "project_ids", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.AOIListResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/aoi/list-aoi" } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Creates a new AOI with specified parameters", "tags": [ "AOI" ], "summary": "Create a new AOI", "operationId": "AOICreateAOI", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.AOICreateModelV2" } } }, "description": "AOI Creation Request", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.AOI" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/aoi/create-aoi" } } }, "/v0/aoi/{aoi_id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get AOI by ID. Only the AOIs under current service user will be accessible.", "tags": [ "AOI" ], "summary": "Get AOI", "operationId": "GetAoiById", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.AOI" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/aoi/get-aoi" } } }, "/v0/search": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Search for satellite images using various filters and parameters. This endpoint uses cursor-based pagination with next_token for efficient navigation through large result sets and consistent behaviour across external providers (Planetary, Element). Use the next_token from the response to fetch subsequent pages of results.", "tags": [ "Search" ], "summary": "Search satellite images", "operationId": "SearchSatelliteImages", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lens.V2Query" } } }, "description": "Search Query Parameters", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lens.V2Response" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/search/satellite-image" } } }, "/v0/satellites": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List of supported satellites. This endpoint returns all available satellites in a single response; pagination is not required as the satellite catalog contains a limited set of entries.", "tags": [ "AOI" ], "summary": "List supported satellites", "operationId": "List Satellites", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/lens.modifiedSuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/search/list-supported-satellites" } } }, "/v0/indices": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Returns a list of all available indices (both custom and preset) with their formulas and metadata. Use the type query parameter to filter by custom or preset.", "tags": [ "Indices" ], "summary": "List all available indices", "operationId": "ListIndices", "parameters": [ { "description": "Offset for pagination", "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } }, { "description": "Limit for pagination", "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 } }, { "description": "Filter by satellite ID", "name": "satellite_id", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by index type (custom/preset)", "name": "type", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by expression type", "name": "expression_type", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by index ID", "name": "index_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.ListIndicesResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/indices/list-indices" } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Creates a new custom index with the provided parameters. This endpoint is for creating custom indices only; preset indices are pre-generated and can be viewed using the list indices endpoint.", "tags": [ "Indices" ], "summary": "Create a new index", "operationId": "CreateIndex", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.IndexCreateRequest" } } }, "description": "Index creation parameters", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.IndexCreateResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/indices/create-index" } } }, "/v0/aois/{aoi_id}/visualizations": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Lists all visualizations for a given AOI with optional filtering", "tags": [ "Visualizations" ], "summary": "List visualizations for an AOI", "operationId": "ListVisualizations", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Offset for pagination", "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } }, { "description": "Limit for pagination", "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 } }, { "description": "Filter by type", "name": "type", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by user ID", "name": "user_id", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by expression type", "name": "expression_type", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by index ID", "name": "index_id", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by visualization ID", "name": "visualization_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.VisualizationListResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/visualizations/list-visualization" } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Creates a new visualization for an AOI using the specified index and assets. For preset index types, both dynamic and theoretical legend metadata are auto-computed. For custom index types with expression_type INDEX, only dynamic legend metadata is computed. For custom index types with expression_type composite or grayscale, no legend metadata is generated.", "tags": [ "Visualizations" ], "summary": "Create a new visualization", "operationId": "CreateVisualization", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.VisualizationCreateRequest" } } }, "description": "Visualization creation parameters", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.VisualizationDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/visualizations/create-visualization" } } }, "/v0/blocks": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Responds with the list of all blocks", "tags": [ "Blocks" ], "summary": "List Blocks", "parameters": [ { "description": "mode is basically the execution mode. Possible values: insight or workflow", "name": "mode", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.ListBlocksTransformerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/blocks/list-blocks" } } }, "/v0/blocks/{name}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Responds with all versions of a specific block", "tags": [ "Blocks" ], "summary": "Get Block Versions", "parameters": [ { "description": "Block name", "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.GetBlockVersionsTransformerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/blocks/get-block-versions" } } }, "/v0/blocks/{name}/versions/{version}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Responds with a specific version of a block", "tags": [ "Blocks" ], "summary": "Get Block by Version", "parameters": [ { "description": "Block name", "name": "name", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Block version", "name": "version", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.BlockSpecItem" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/blocks/get-block-by-version" } } }, "/v0/aoi/{aoi_id}/insights": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Creates an insight or get the estimated cost of running the insight.", "tags": [ "Insights" ], "summary": "Create Insights on an AOI", "operationId": "createInsights", "parameters": [ { "description": "ID of the AOI on which you want to run the insight", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.CreateInsightsWildcardTransformerRequest" } } }, "description": "Create Insight request body", "required": true }, "responses": { "200": { "description": "When estimating cost", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.CreateInsightCostEstimateUpstreamResponseBody" } } } }, "201": { "description": "When creating an insight", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.CreateInsightUpstreamResponseBody" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/insights/create-insight" } } }, "/v0/aoi/{aoiId}/insights": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Responds with the list of inisghts details as JSON.", "tags": [ "Insights" ], "summary": "List Insights", "operationId": "listInsights", "parameters": [ { "description": "ID of the AOI", "name": "aoiId", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Get a specific insight by it's unique id", "name": "id", "in": "query", "schema": { "type": "string" } }, { "description": "Filter insights by their status", "name": "status", "in": "query", "schema": { "type": "string" } }, { "description": "Filter insights by the creator's user id", "name": "created_by", "in": "query", "schema": { "type": "string" } }, { "description": "Filter insights by the time they were created on. Timestamps should be RFC3339 compliant. For dates, provide values like `2025-04-14T00:00:00Z`", "name": "created_on", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.ListInsightsTransformerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/insights/list-insights" } } }, "/v0/aoi/{aoi_id}/insights/{insight_id}/download": { "put": { "security": [ { "ApiKeyAuth": [] } ], "description": "Creates a download package containing the specified input and output files from an insight", "tags": [ "Insights" ], "summary": "Download Insights", "operationId": "downloadInsights", "parameters": [ { "description": "aoiId", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "insightId", "name": "insight_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.PutInsightsUpstreamRequestBody" } } }, "description": "Specify which inputs and outputs to include" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.PutInsightsUpstreamResponseBody" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/insights/download-insights" } } }, "/v0/aoi/{aoi_id}/insights/{insight_id}": { "delete": { "security": [ { "ApiKeyAuth": [] } ], "description": "Deletes an insight", "tags": [ "Insights" ], "summary": "Delete Insights", "operationId": "deleteInsights", "parameters": [ { "description": "ID of the AOI", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "ID of the insight which was run on the AOI", "name": "insight_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "ID of the project to which the AOI belongs", "name": "project_id", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/insights/delete-insights" } } }, "/v0/aois/{aoi_id}/assets": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List all assets for a given AOI with optional filtering", "tags": [ "Assets" ], "summary": "List assets for an AOI", "operationId": "ListAssets", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Offset for pagination", "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } }, { "description": "Limit for pagination", "name": "limit", "in": "query", "schema": { "type": "integer", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.AssetListResponseModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/assets/list-assets" } } }, "/v0/aois/{aoi_id}/downloads": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Creates a download request for specified assets in an AOI", "tags": [ "Downloads" ], "summary": "Create a download request for assets in an AOI", "operationId": "AOICreateDownload", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.DownloadCreateModel" } } }, "description": "Download Request", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.DownloadReadModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/assets/create-download" } } }, "/v0/aois/{aoi_id}/downloads/{download_id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Gets the status of a download request for an AOI", "tags": [ "Downloads" ], "summary": "Get status of a download request", "operationId": "GetDownloadStatus", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Download ID", "name": "download_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.DownloadReadModel" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/assets/get-status-download-request" } } }, "/v0/workflows": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List workflows with pagination. Returns paginated results with limit (default: 50) and offset (default: 0) parameters. The response always includes pagination metadata with total count.", "tags": [ "Workflows" ], "summary": "List workflows", "operationId": "listWorkflows", "parameters": [ { "description": "Unique identifier for the project containing the workflows", "name": "project_id", "in": "query", "schema": { "type": "string" } }, { "description": "Filter by specific workflow ID", "name": "id", "in": "query", "schema": { "type": "string" } }, { "description": "Filter workflows by display name", "name": "name", "in": "query", "schema": { "type": "string" } }, { "description": "Filter workflows by creator's user id", "name": "created_by", "in": "query", "schema": { "type": "string" } }, { "description": "Filter workflows by creation date", "name": "created_on", "in": "query", "schema": { "type": "string" } }, { "description": "Filter workflows by last modification timestamp", "name": "updated_at", "in": "query", "schema": { "type": "string" } }, { "description": "Offset for pagination", "name": "offset", "in": "query", "schema": { "type": "integer", "default": 0 } }, { "description": "Limit for pagination", "name": "limit", "in": "query", "schema": { "type": "integer", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.ListWorkflowsTransformerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/workflows/list-workflow" } } }, "/v0/workflows/{workflow_id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get workflows by a ID", "tags": [ "Workflows" ], "summary": "Get Workflows By Id", "operationId": "getWorkflowsById", "parameters": [ { "description": "Unique UUID identifier for the target workflow", "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Project identifier that the workflow belongs to", "name": "project_id", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.GetWorkflowsByIdTransformerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/workflows/get-workflow" } } }, "/v0/workflows/{workflow_id}/estimate": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get Workflow Cost estimate", "tags": [ "Workflows" ], "summary": "Get Workflow Cost estimate", "operationId": "getWorkflowCostEstimate", "parameters": [ { "description": "Unique ID of the workflow to estimate cost for", "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.GetWorkflowCostEstimateTransformerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/workflows/workflow-cost-estimate" } } }, "/v0/workflows/{workflow_id}/jobs": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List Jobs for a given workflow id", "tags": [ "Jobs" ], "summary": "List Jobs", "operationId": "listJobs", "parameters": [ { "description": "Unique identifier for the workflow to list jobs from", "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Filter by specific job ID", "name": "id", "in": "query", "schema": { "type": "string" } }, { "description": "Filter jobs by their current status (e.g., running, completed)", "name": "status", "in": "query", "schema": { "type": "string" } }, { "description": "Filter jobs by user who created them", "name": "created_by", "in": "query", "schema": { "type": "string" } }, { "description": "Filter jobs by creation date", "name": "created_on", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.ListJobsTransformerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/jobs/list-jobs" } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Create a job from a given workflow", "tags": [ "Jobs" ], "summary": "Create a job from a given workflow", "operationId": "createJob", "parameters": [ { "description": "Unique identifier for the workflow to create a job from", "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Project identifier the workflow belongs to", "name": "project_id", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.PostWorkflowRunTransformerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/jobs/create-job" } } }, "/v0/workflows/{workflow_id}/jobs/{job_id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get Job by Id and WF Id", "tags": [ "Jobs" ], "summary": "Get Job by Id and WF Id", "operationId": "getJobById", "parameters": [ { "description": "Unique identifier for the workflow", "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Unique identifier for the job within the workflow", "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.GetJobByIdTransformerResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/jobs/get-job" } } }, "/v0/workflows/{workflow_id}/jobs/{job_id}/download": { "put": { "security": [ { "ApiKeyAuth": [] } ], "description": "Creates a download package containing the specified input and output files from a job run of a workflow.", "tags": [ "Jobs" ], "summary": "Download Job", "operationId": "downloadJob", "parameters": [ { "description": "Unique ID of the workflow to download assets from", "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Specific job ID within the workflow from which to create download package", "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.PutJobUpstreamResponseBody" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/jobs/download-job" } } }, "/v0/workflows/{workflow_id}/jobs/{job_id}/tasks/{task_id}/download": { "put": { "security": [ { "ApiKeyAuth": [] } ], "description": "Creates a download package containing the specified task assets from a job run of a workflow.", "tags": [ "Tasks" ], "summary": "Download Task", "operationId": "downloadTask", "parameters": [ { "description": "Unique ID for the workflow to download from", "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Specific job execution ID within the workflow", "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Target task ID containing assets to download", "name": "task_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dexter.PutTaskUpstreamResponseBody" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/jobs/download-task" } } }, "/v0/bandsets": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List of all bandsets, that can be used to place a tasking order.", "tags": [ "Bandset" ], "summary": "List all bandsets", "operationId": "ListBandsets", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ListBandsets" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/bandsets" } } }, "/v0/orders": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List of all orders in the workspace.", "tags": [ "Order" ], "summary": "List all orders", "operationId": "ListOrders", "parameters": [ { "description": "User ID", "name": "user_id", "in": "query", "schema": { "type": "string" } }, { "description": "Limit", "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "description": "Offset", "name": "offset", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ListOrdersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/order-orderitem" } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Create a new order with tasking or/and archive orderitems", "tags": [ "Order" ], "summary": "Create an order", "operationId": "SubmitOrder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.docOriginalOrderRequest" } } }, "description": "Request Body", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.Order" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/tasking" } } }, "/v0/orders/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get an order by it's ID with it's associated orderitems.", "tags": [ "Order" ], "summary": "Get an order", "operationId": "GetOrderById", "parameters": [ { "description": "Order ID", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.Order" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/order-orderitem" } } }, "/v0/order-items": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List of all order-items in the workspace, the response is paginated.", "tags": [ "Order" ], "summary": "List all orderItems", "operationId": "ListOrderItems", "parameters": [ { "description": "User ID", "name": "user_id", "in": "query", "schema": { "type": "string" } }, { "description": "Type", "name": "type", "in": "query", "schema": { "type": "string" } }, { "description": "Status", "name": "status", "in": "query", "schema": { "type": "string" } }, { "description": "Order IDs", "name": "order_ids", "in": "query", "schema": { "type": "string" } }, { "description": "Created By", "name": "created_by", "in": "query", "schema": { "type": "string" } }, { "description": "Created At Range", "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "description": "Project IDs", "name": "project_ids", "in": "query", "schema": { "type": "string" } }, { "description": "IDs", "name": "ids", "in": "query", "schema": { "type": "string" } }, { "description": "Area Range", "name": "area", "in": "query", "schema": { "type": "string" } }, { "description": "Limit", "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "description": "Offset", "name": "offset", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ListOrderItemsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/order-orderitem" } } }, "/v0/order-items/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get an orderitem by it's ID, it will also return the list of tasks associated with the ID.", "tags": [ "Order" ], "summary": "Get an orderItem", "operationId": "GetOrderItemById", "parameters": [ { "description": "OrderItem ID", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.OrderItemResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/order-orderitem" } } }, "/v0/archives/collections": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Returns a list of all collections available under archives.", "tags": [ "Archives" ], "summary": "List all collections", "operationId": "ListCollections", "parameters": [ { "description": "Collection IDs", "name": "ids", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cosmos.modifiedSuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/stac" } } }, "/v0/archives/collections/{cid}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get a STAC collection by it's ID", "tags": [ "Archives" ], "summary": "Get a collection", "operationId": "GetCollectionById", "parameters": [ { "description": "Collection ID", "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cosmos.originalCollectionSuccessResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/stac" } } }, "/v0/archives/collections/{cid}/items": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List of items present in a collection", "tags": [ "Archives" ], "summary": "List items in a collection", "operationId": "ListItemInCollection", "parameters": [ { "description": "Collection ID", "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Limit", "name": "limit", "in": "query", "schema": { "type": "integer" } }, { "description": "Offset", "name": "offset", "in": "query", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cosmos.FeatureCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/archive" } } }, "/v0/archives/collections/{cid}/items/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get a STAC item by it's collection and item ID", "tags": [ "Archives" ], "summary": "Get item", "operationId": "GetCollectionItemById", "parameters": [ { "description": "Collection ID", "name": "cid", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Item ID", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cosmos.Item" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/archive" } } }, "/v0/archives/search": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Search for STAC items according to attributes of the item", "tags": [ "Archives" ], "summary": "Search all items", "operationId": "SearchItemInArchive", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cosmos.Search" } } }, "description": "Request Body", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cosmos.FeatureCollection" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/search-archive" } } }, "/v0/reports": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Download the entire order history report for the organization, successful response is in csv format.", "tags": [ "Report" ], "summary": "download order report", "operationId": "DownloadOrderReport", "parameters": [ { "description": "local timezone of the client", "name": "tz", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "text/csv": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } } } }, "/v0/stores": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List stores under current workspace", "tags": [ "Stores" ], "summary": "List stores", "operationId": "ListStores", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/courier.ListStoresResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/stores" } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Create a store to export data to, under current workspace", "tags": [ "Stores" ], "summary": "Create a store", "operationId": "CreateStore", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/courier.CreateStoreRequest" } } }, "description": "Create Store", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/courier.CreateStoreResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/stores" } } }, "/v0/stores/{id}": { "delete": { "security": [ { "ApiKeyAuth": [] } ], "description": "Delete a store under current workspace", "tags": [ "Stores" ], "summary": "Delete a store", "operationId": "DeleteStore", "parameters": [ { "description": "Delete Store id", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/stores" } } }, "/v0/catalogs/deliveries": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "List of all deliveries for the workspace", "tags": [ "Catalog" ], "summary": "List all deliveries", "operationId": "ListDeliveries", "parameters": [ { "description": "Delivery ID", "name": "delivery_id", "in": "query", "schema": { "type": "string" } }, { "description": "Catalog ID", "name": "catalog_id", "in": "query", "schema": { "type": "string" } }, { "description": "Task ID", "name": "task_id", "in": "query", "schema": { "type": "string" } }, { "description": "Order Item ID", "name": "order_item_id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ListDeliveries" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/delivery-download" } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Create a delivery request which will be fulfilled async, only one of catalog id or order_item should be populated in a single delivery request.", "tags": [ "Catalog" ], "summary": "Create deliveries", "operationId": "CreateDelivery", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.CreateDeliveryRequest" } } }, "description": "Request Body", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ListDeliveries" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/delivery-download" } } }, "/v0/catalogs/download": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Create a download resource which will get populated with a signed url async. Only one of orderitem or catalog id should be populated in a single request.", "tags": [ "Catalog" ], "summary": "Create a download resource", "operationId": "CreateDownload", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.DownloadRequest" } } }, "description": "Request Body", "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.DownloadResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/delivery-download" } } }, "/v0/catalogs/download/{download_id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get the current status of a download resource, signed_url field will be populated only if the operation is successful.", "tags": [ "Catalog" ], "summary": "Get download status", "operationId": "GetDownloadById", "parameters": [ { "description": "Download ID", "name": "download_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.DownloadResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/delivery-download" } } }, "/v0/catalogs/search": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Search all catalogs owned by the workspace", "tags": [ "Catalog" ], "summary": "Search all catalogs", "operationId": "SearchCatalogs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.originalCatalogFilter" } } }, "description": "Catalog filter", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.SearchCatalogsResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/catalog" } } }, "/v0/catalogs/{id}": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "Get a single catalog by ID", "tags": [ "Catalog" ], "summary": "Get a catalog", "operationId": "GetCatalogById", "parameters": [ { "description": "Catalog ID", "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.Catalog" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/clerk.ErrorResponse" } } } } }, "externalDocs": { "description": "View developer guide to learn more", "url": "/developer/orders/catalog" } } }, "/v0/aois/{aoi_id}/visualizations/{visualization_id}/metadata": { "put": { "security": [ { "ApiKeyAuth": [] } ], "description": "Updates the visualization metadata legend for a specific mode (dynamic or theoretical). Only the specified mode is updated; the other mode is preserved.", "tags": [ "Visualizations" ], "summary": "Update visualization metadata", "operationId": "UpdateVisualizationMetadata", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Visualization ID", "name": "visualization_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.VisualizationMetadataUpdateRequest" } } }, "description": "Visualization metadata update parameters", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.VisualizationMetadata" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } } }, "patch": { "security": [ { "ApiKeyAuth": [] } ], "description": "Rolls back the visualization metadata for specified dates and mode. Recomputes the legend for the specified mode from source data, preserving the other mode.", "tags": [ "Visualizations" ], "summary": "Rollback visualization metadata", "operationId": "RollbackVisualizationMetadata", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Visualization ID", "name": "visualization_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.VisualizationMetadataRollbackRequest" } } }, "description": "Visualization metadata rollback parameters", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.VisualizationDetailResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } } } }, "/v0/aois/{aoi_id}/visualizations/{visualization_id}/png": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Generates an on-the-fly PNG of the index for a given date and mode, with legend overlay. Returns the PNG image as binary data.", "tags": [ "Visualizations" ], "summary": "Generate an index PNG for a visualization", "operationId": "GenerateIndexPng", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Visualization ID", "name": "visualization_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.PngRequest" } } }, "description": "PNG generation parameters", "required": true }, "responses": { "200": { "description": "OK", "content": { "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "image/png": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "image/png": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "image/png": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "image/png": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "image/png": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } } } }, "/v0/aois/{aoi_id}/visualizations/{visualization_id}/sld": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "Generates Styled Layer Descriptor (SLD) XML for the specified dates and visualization modes. Returns SLD grouped by mode and date.", "tags": [ "Visualizations" ], "summary": "Generate SLD styles for a visualization", "operationId": "GenerateVisualizationSLD", "parameters": [ { "description": "AOI ID", "name": "aoi_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "description": "Visualization ID", "name": "visualization_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.SLDRequest" } } }, "description": "SLD generation parameters", "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/atlas.SLDResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/common.ErrorResponse" } } } } } } } }, "servers": [ { "url": "https://api.pixxel.space" } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "name": "Authorization", "in": "header" } }, "schemas": { "atlas.AOI": { "type": "object", "properties": { "aoi_id": { "description": "Unique identifier (UUID) of the created AOI", "type": "string", "x-order": "100", "example": "e9767554-550e-4464-a677-b8cf096073ab" }, "name": { "description": "Unique user friendly name of the AOI for easier identification", "type": "string", "x-order": "101", "example": "AOI-D2" }, "description": { "description": "Brief description of the AOI explaining its purpose or contents", "type": "string", "x-order": "102", "example": "This AOI contains images of D2" }, "satellite_id": { "description": "Unique identifier (UUID) for the satellite. Each satellite has a unique ID mapped to its name: - `Pixxel-TD1` - `0004ab8d-0ad1-4d62-8a3f-fe18a7000e70` - `Pixxel-TD2` - `0005c5bb-0bd2-4c80-9393-4a808341c54c`", "type": "string", "x-order": "103", "example": "0005c5bb-0bd2-4c80-9393-4a808341c54c" }, "project_id": { "description": "UUID of the project this AOI belongs to", "type": "string", "x-order": "104", "example": "ce5dcc14-8291-4b0c-a278-8c05ec426d22" }, "images": { "description": "Map of images associated with the AOI, keyed by image identifier", "type": "object", "additionalProperties": true, "x-order": "105" }, "eo_bands": { "description": "List of Earth Observation bands available for this AOI", "type": "array", "items": { "type": "string" }, "x-order": "106", "example": [ "B01", "B02", "B03" ] }, "geometry": { "description": "GeoJSON Polygon geometry defining the geographic boundary of the AOI", "allOf": [ { "$ref": "#/components/schemas/atlas.Polygon" } ], "x-order": "107" }, "progress": { "description": "Processing progress of the AOI from 0 to 100 in percentage", "type": "integer", "x-order": "108", "example": 100 }, "status": { "description": "Current status of the AOI: success, started, running, failed, updating, partial_success", "allOf": [ { "$ref": "#/components/schemas/atlas.AOIStatus" } ], "x-order": "109", "example": "success" }, "is_favourite": { "description": "Whether the AOI is marked as favourite by the user", "type": "boolean", "x-order": "110", "example": false }, "created_at": { "description": "Timestamp when the AOI was created (ISO 8601 format)", "type": "string", "x-order": "111", "example": "2022-11-14T12:55:49.125928+00:00" }, "updated_at": { "description": "Timestamp when the AOI was last updated (ISO 8601 format)", "type": "string", "x-order": "112", "example": "2022-11-14T12:55:49.125928+00:00" }, "user_id": { "description": "Unique identifier of the user who created the AOI", "type": "string", "x-order": "113", "example": "user-123456" }, "area_in_sq_m": { "description": "Total area of the AOI in square meters", "type": "number", "x-order": "114", "example": 123456.78 }, "centroid": { "description": "Geographic centroid coordinates of the AOI [longitude, latitude]", "type": "array", "items": { "type": "number" }, "x-order": "115", "example": [ 77.55, 12.95 ] } } }, "atlas.AOICreateModelV2": { "type": "object", "required": [ "description", "geometry", "item_ids", "name", "project_id", "provider", "satellite_id" ], "properties": { "name": { "description": "Unique user friendly name of the AOI for easier identification", "type": "string", "x-order": "100", "example": "AOI-D2" }, "description": { "description": "Brief description of the AOI explaining its purpose or contents", "type": "string", "x-order": "101", "example": "This AOI contains images of D2" }, "satellite_id": { "description": "Unique identifier (UUID) for the satellite. Each satellite has a unique ID mapped to its name: - `Pixxel-TD1` - `0004ab8d-0ad1-4d62-8a3f-fe18a7000e70` - `Pixxel-TD2` - `0005c5bb-0bd2-4c80-9393-4a808341c54c`", "type": "string", "x-order": "102", "example": "0005c5bb-0bd2-4c80-9393-4a808341c54c" }, "provider": { "description": "Data provider source for satellite imagery: - `pixxel` - For TD and Firefly satellite imagery - `planetary` - For all open source satellite data (Landsat, Sentinel, etc.)", "type": "string", "x-order": "103", "example": "pixxel" }, "project_id": { "description": "UUID of the project this AOI belongs to. The AOI will be associated with this project for organization", "type": "string", "x-order": "104", "example": "ce5dcc14-8291-4b0c-a278-8c05ec426d22" }, "geometry": { "description": "Polygon geometry defining the geographic boundary of the AOI", "allOf": [ { "$ref": "#/components/schemas/atlas.Polygon" } ], "x-order": "105" }, "item_ids": { "description": "Array of satellite image item IDs to include in this AOI. Item IDs Example: `[\"TD2_000650_20230404_L2A_20240405_01001067\", \"TD1_005630_20230314_L2A_20230504_03001069\"]`", "type": "array", "items": { "type": "string" }, "x-order": "106", "example": [ "TD2_00056_20230815_L2A_004010_01001001" ] } } }, "atlas.AOIListResponse": { "type": "object", "properties": { "aois": { "type": "array", "items": { "$ref": "#/components/schemas/atlas.AOI" } }, "pagination": { "$ref": "#/components/schemas/common.Pagination" } } }, "atlas.AOIStatus": { "type": "string", "enum": [ "success", "started", "running", "failed", "updating", "partial_success" ], "x-enum-varnames": [ "AOIStatusSuccess", "AOIStatusStarted", "AOIStatusRunning", "AOIStatusFailed", "AOIStatusUpdating", "AOIStatusPartial_Success" ] }, "atlas.Asset": { "type": "object", "properties": { "aoi_id": { "type": "string", "example": "e9767554-550e-4464-a677-b8cf096073ab" }, "area_in_sq_m": { "type": "number", "example": 0 }, "asset_type": { "allOf": [ { "$ref": "#/components/schemas/atlas.AssetType" } ], "example": "mosaic" }, "band_list": { "type": "array", "items": { "type": "string" }, "example": [ "B01", "B02" ] }, "centroid": { "type": "array", "items": { "type": "number" }, "example": [ 77.55, 12.95 ] }, "created_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" }, "date": { "type": "string", "example": "2022-11-14" }, "description": { "type": "string", "example": "This asset is mosaic file" }, "geometry": { "$ref": "#/components/schemas/atlas.Polygon" }, "id": { "type": "string", "example": "e9767554-550e-4464-a677-b8cf096073ab" }, "name": { "type": "string", "example": "Asset-A" }, "path": { "type": "string", "example": "https://storage.account" }, "progress": { "type": "integer", "example": 0 }, "resolution": { "type": "number", "example": 10 }, "status": { "allOf": [ { "$ref": "#/components/schemas/atlas.AssetStatus" } ], "example": "success" }, "updated_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" }, "visualization_id": { "type": "string", "example": "e9767554-550e-4464-a677-b8cf096073ab" } } }, "atlas.AssetListResponseModel": { "type": "object", "properties": { "assets": { "type": "array", "items": { "$ref": "#/components/schemas/atlas.AssetReadModel" } }, "pagination": { "$ref": "#/components/schemas/common.Pagination" } } }, "atlas.AssetReadModel": { "type": "object", "properties": { "aoi_id": { "type": "string", "example": "e9767554-550e-4464-a677-b8cf096073ab" }, "area_in_sq_m": { "type": "number", "example": 0 }, "asset_type": { "allOf": [ { "$ref": "#/components/schemas/atlas.AssetType" } ], "example": "mosaic" }, "band_list": { "type": "array", "items": { "type": "string" }, "example": [ "B01", "B02" ] }, "centroid": { "type": "array", "items": { "type": "number" }, "example": [ 77.55, 12.95 ] }, "created_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" }, "date": { "type": "string", "example": "2022-11-14" }, "description": { "type": "string", "example": "This asset is mosaic file" }, "geometry": { "$ref": "#/components/schemas/atlas.Polygon" }, "id": { "type": "string", "example": "e9767554-550e-4464-a677-b8cf096073ab" }, "name": { "type": "string", "example": "Asset-A" }, "path": { "type": "string", "example": "https://storage.account" }, "progress": { "type": "integer", "example": 0 }, "resolution": { "type": "number", "example": 10 }, "status": { "allOf": [ { "$ref": "#/components/schemas/atlas.AssetStatus" } ], "example": "success" }, "updated_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" }, "visualization_id": { "type": "string", "example": "e9767554-550e-4464-a677-b8cf096073ab" } } }, "atlas.AssetStatus": { "type": "string", "enum": [ "success", "failed", "started", "creating" ], "x-enum-varnames": [ "AssetStatusSuccess", "AssetStatusFailed", "AssetStatusStarted", "AssetStatusCreating" ] }, "atlas.AssetType": { "type": "string", "enum": [ "mosaic", "stac_item", "visualization" ], "x-enum-varnames": [ "MosaicAssetType", "STACItemAssetType", "VisualizationAssetType" ] }, "atlas.DownloadCreateModel": { "type": "object", "required": [ "asset_ids" ], "properties": { "asset_ids": { "type": "array", "items": { "type": "string" }, "example": [ "00173fc9-7ea6-49a6-b030-620df1cf822d", "49a6-b030-620df1cf822d-00173fc9-7ea6" ] } } }, "atlas.DownloadReadModel": { "type": "object", "properties": { "download_id": { "type": "string", "example": "dc01addf-b6c3-4fa9-9a49-dcdcb4c99229" }, "signed_url": { "type": "string", "example": "https://storage.account/download" }, "status": { "type": "string", "example": "SUCCESS" } } }, "atlas.ExpressionType": { "type": "string", "enum": [ "composite", "index", "grayscale" ], "x-enum-varnames": [ "ExpressionTypeComposite", "ExpressionTypeIndex", "ExpressionTypeGrayscale" ] }, "atlas.IndexCreateRequest": { "type": "object", "required": [ "colormap", "description", "expression", "expression_type", "name", "rescale", "satellite_id" ], "properties": { "name": { "type": "string", "x-order": "100", "example": "NDVI" }, "description": { "type": "string", "x-order": "101", "example": "This formula will give insights about vegetation" }, "rescale": { "type": "array", "items": { "type": "integer" }, "x-order": "102", "example": [ 0, 1 ] }, "expression": { "type": "string", "x-order": "103", "example": "(B04-B08)/(B04+B08)" }, "colormap": { "type": "string", "x-order": "104", "example": "rplumbho" }, "satellite_id": { "type": "string", "x-order": "105", "example": "0002a3a3-00a2-4b55-842b-44d8202c6d60" }, "expression_type": { "allOf": [ { "$ref": "#/components/schemas/atlas.ExpressionType" } ], "x-order": "106", "example": "index" } } }, "atlas.IndexCreateResponse": { "type": "object", "properties": { "bands": { "type": "array", "items": { "type": "string" }, "example": [ "B01", "B02", "B03" ] }, "colormap": { "type": "string", "example": "rplumbho" }, "created_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" }, "description": { "type": "string", "example": "This formula will give insights about vegetation" }, "expression": { "type": "string", "example": "(B04-B08)/(B04+B08)" }, "expression_type": { "allOf": [ { "$ref": "#/components/schemas/atlas.ExpressionType" } ], "example": "index" }, "id": { "type": "string", "example": "e9767554-550e-4464-a677-b8cf096073ab" }, "name": { "type": "string", "example": "NDVI" }, "rescale": { "type": "array", "items": { "type": "integer" }, "example": [ 0, 1 ] }, "satellite_id": { "type": "string", "example": "0002a3a3-00a2-4b55-842b-44d8202c6d60" }, "type": { "allOf": [ { "$ref": "#/components/schemas/atlas.IndexType" } ], "example": "custom" }, "updated_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" } } }, "atlas.IndexEntity": { "type": "object", "properties": { "bands": { "type": "array", "items": { "type": "string" } }, "colormap": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": "string" }, "expression": { "type": "string" }, "expression_type": { "$ref": "#/components/schemas/atlas.ExpressionType" }, "id": { "type": "string" }, "name": { "type": "string" }, "rescale": { "type": "array", "items": { "type": "integer" } }, "satellite_id": { "type": "string" }, "type": { "$ref": "#/components/schemas/atlas.IndexType" }, "updated_at": { "type": "string" } } }, "atlas.IndexType": { "type": "string", "enum": [ "custom", "preset" ], "x-enum-varnames": [ "Custom", "Preset" ] }, "atlas.LegendItem": { "type": "object", "properties": { "area": { "type": "number", "example": 50 }, "area_percentage": { "type": "number", "example": 5 }, "color": { "type": "string", "example": "#2b83ba" }, "label": { "type": "string", "example": "Very Low" }, "max": { "type": "number", "example": 51 }, "min": { "type": "number", "example": 0 } } }, "atlas.LegendItemUpdateRequest": { "type": "object", "properties": { "color": { "type": "string", "example": "#2b83ba" }, "label": { "type": "string", "example": "Very Low" }, "max": { "type": "number", "example": 51 }, "min": { "type": "number", "example": 0 } } }, "atlas.ListIndicesResponse": { "type": "object", "properties": { "indices": { "type": "array", "items": { "$ref": "#/components/schemas/atlas.IndexEntity" } }, "pagination": { "$ref": "#/components/schemas/common.Pagination" } } }, "atlas.PngRequest": { "type": "object", "required": [ "date", "index_id", "visualization_mode" ], "properties": { "index_id": { "description": "UUID of the index to compute the preview for", "type": "string", "x-order": "100", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "date": { "description": "Date string, e.g. 2024_05_06", "type": "string", "x-order": "101", "example": "2024_05_06" }, "visualization_mode": { "description": "Legend mode to use: 'dynamic' or 'theoretical'", "type": "string", "enum": [ "dynamic", "theoretical" ], "x-order": "102", "example": "dynamic" } } }, "atlas.Polygon": { "type": "object", "required": [ "coordinates", "type" ], "properties": { "type": { "description": "GeoJSON geometry type. Must be \"Polygon\" for AOI boundaries", "type": "string", "x-order": "100", "example": "Polygon" }, "coordinates": { "description": "Nested array of coordinates [[[lng,lat],...]] forming a closed polygon. Example: [[[49.32, 40.85], [49.32, 9.08], [110.7, 9.08], [110.7, 40.85], [49.32, 40.85]]]", "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "x-order": "101" } } }, "atlas.SLDRequest": { "type": "object", "required": [ "dates", "visualization_modes" ], "properties": { "dates": { "description": "List of dates to generate SLD for", "type": "array", "items": { "type": "string" }, "x-order": "100", "example": [ "2024_05_06", "2024_05_07" ] }, "visualization_modes": { "description": "Visualization modes to generate SLD for", "type": "array", "items": { "$ref": "#/components/schemas/atlas.VisualizationMode" }, "x-order": "101", "example": [ "dynamic", "theoretical" ] } } }, "atlas.SLDResponse": { "type": "object", "properties": { "sld": { "description": "Nested map: mode -> date -> SLD XML string", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "atlas.VisualizationCreateRequest": { "type": "object", "required": [ "index_id" ], "properties": { "index_id": { "description": "UUID of the index to use for this visualization", "type": "string", "x-order": "100", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "src_asset_ids": { "description": "Optional list of source asset IDs to include in the visualization", "type": "array", "items": { "type": "string" }, "x-order": "101", "example": [ "e3a671ad-5381-4413-8c1c-bc4e1ccaff45", "90d63531-5f54-4704-a4b0-7bb92ae08f23" ] }, "resolution": { "description": "Optional resolution override. If not provided, defaults to the satellite's default resolution", "type": "number", "x-order": "102", "example": 10 } } }, "atlas.VisualizationDetailResponse": { "type": "object", "properties": { "aoi_id": { "type": "string", "example": "e9767554-550e-4464-a677-b8cf096073ab" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/atlas.Asset" } }, "created_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" }, "expression": { "type": "string", "example": "(B08 - B04) / (B08 + B04)" }, "expression_type": { "allOf": [ { "$ref": "#/components/schemas/atlas.ExpressionType" } ], "example": "index" }, "id": { "type": "string", "example": "a80f7f4c-abe9-4118-875e-3a2306577e11" }, "index_id": { "type": "string", "example": "90d63531-5f54-4704-a4b0-7bb92ae08f23" }, "index_name": { "type": "string", "example": "NDVI-Custom" }, "metadata": { "$ref": "#/components/schemas/atlas.VisualizationMetadata" }, "progress": { "type": "integer", "example": 100 }, "rescale": { "type": "array", "items": { "type": "integer" }, "example": [ 0, 1 ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/atlas.VisualizationStatus" } ], "example": "success" }, "tenant_id": { "type": "string", "example": "tenant-123456" }, "type": { "allOf": [ { "$ref": "#/components/schemas/atlas.VisualizationType" } ], "example": "custom" }, "updated_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" }, "user_id": { "type": "string", "example": "e3a671ad-5381-4413-8c1c-bc4e1ccaff45" } } }, "atlas.VisualizationLegends": { "type": "object", "properties": { "dynamic": { "type": "array", "items": { "$ref": "#/components/schemas/atlas.LegendItem" } }, "theoretical": { "type": "array", "items": { "$ref": "#/components/schemas/atlas.LegendItem" } } } }, "atlas.VisualizationListItem": { "type": "object", "properties": { "aoi_id": { "type": "string", "example": "e9767554-550e-4464-a677-b8cf096073ab" }, "created_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" }, "id": { "type": "string", "example": "a80f7f4c-abe9-4118-875e-3a2306577e11" }, "index_id": { "type": "string", "example": "90d63531-5f54-4704-a4b0-7bb92ae08f23" }, "progress": { "type": "integer", "example": 100 }, "status": { "allOf": [ { "$ref": "#/components/schemas/atlas.VisualizationStatus" } ], "example": "success" }, "tenant_id": { "type": "string", "example": "tenant-123456" }, "updated_at": { "type": "string", "example": "2022-11-14 12:55:49.125928+00:00" }, "user_id": { "type": "string", "example": "e3a671ad-5381-4413-8c1c-bc4e1ccaff45" } } }, "atlas.VisualizationListResponse": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/common.Pagination" }, "visualization": { "type": "array", "items": { "$ref": "#/components/schemas/atlas.VisualizationListItem" } } } }, "atlas.VisualizationMetadata": { "type": "object", "properties": { "legend": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/atlas.VisualizationLegends" } } } }, "atlas.VisualizationMetadataRollbackRequest": { "type": "object", "required": [ "dates", "index_id", "visualization_mode" ], "properties": { "index_id": { "description": "The index ID for this visualization", "type": "string", "x-order": "100", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "dates": { "description": "List of date strings to rollback", "type": "array", "items": { "type": "string" }, "x-order": "101", "example": [ "2024_05_06", "2025_11_14" ] }, "visualization_mode": { "description": "Which legend mode to rollback (dynamic or theoretical)", "allOf": [ { "$ref": "#/components/schemas/atlas.VisualizationMode" } ], "x-order": "102", "example": "dynamic" } } }, "atlas.VisualizationMetadataUpdateRequest": { "type": "object", "required": [ "legend", "visualization_mode" ], "properties": { "visualization_mode": { "description": "Which legend mode to update (dynamic or theoretical)", "allOf": [ { "$ref": "#/components/schemas/atlas.VisualizationMode" } ], "x-order": "100", "example": "theoretical" }, "legend": { "description": "Legend breakpoints per date. For dynamic mode, values can be null (auto-computed)", "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/atlas.LegendItemUpdateRequest" } }, "x-order": "101" }, "dynamic_bins": { "description": "Number of equal-interval bins for dynamic mode (1-15). Required when visualization_mode is dynamic", "type": "integer", "x-order": "102", "example": 5 } } }, "atlas.VisualizationMode": { "type": "string", "enum": [ "dynamic", "theoretical" ], "x-enum-varnames": [ "VisualizationModeDynamic", "VisualizationModeTheoretical" ] }, "atlas.VisualizationStatus": { "type": "string", "enum": [ "creating", "success", "failed", "partial_success" ], "x-enum-varnames": [ "VizStatusCreating", "VizStatusSuccess", "VizStatusFailed", "VizStatusPartialSuccess" ] }, "atlas.VisualizationType": { "type": "string", "enum": [ "custom" ], "x-enum-varnames": [ "CustomType" ] }, "clerk.Asset": { "type": "object", "properties": { "eo:bands": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.EoBand" } }, "href": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "type": { "type": "string" } } }, "clerk.Band": { "type": "object", "properties": { "name": { "description": "name of the band", "type": "string", "example": "B001" }, "wavelength": { "description": "wavelength of the band in nm", "type": "number", "example": 473 } } }, "clerk.Bandset": { "type": "object", "properties": { "bands": { "description": "list of bands in the bandset", "type": "array", "items": { "$ref": "#/components/schemas/clerk.Band" } }, "captures": { "description": "number of captures required to fulfill the order for the current bandset. tasking order cost is dependent on the number of captures required by the bandset", "type": "integer", "example": 1 }, "description": { "description": "description of the bandset", "type": "string", "example": "Agriculture bandset" }, "id": { "description": "id of the bandset", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "name": { "description": "name of the bandset", "type": "string", "example": "Agriculture" } } }, "clerk.Catalog": { "type": "object", "properties": { "area": { "description": "area of the catalog in sq. km", "type": "number", "example": 100 }, "bandset_id": { "description": "id of the bandset present in the catalog", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92277" }, "created_at": { "description": "timestamp of the creation of the catalog", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "created_by": { "description": "uuid of the user who created the catalog", "type": "string", "example": "0d7b3c5e-3b2a-4e77-bedb-5e0d2257cdb6" }, "delivery_status": { "description": "status of the delivery of the catalog, in case automated delivery was enabled", "allOf": [ { "$ref": "#/components/schemas/clerk.DeliveryStatus" } ], "example": "SUCCESSFUL" }, "details": { "description": "STAC item info of the catalog", "allOf": [ { "$ref": "#/components/schemas/clerk.STACItem" } ] }, "id": { "description": "id of the catalog", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "org_id": { "description": "id of the workspace to which the catalog belongs", "type": "string", "example": "e31ab6f8-d359-4c6a-83c6-bfa322 29bb01" }, "task_id": { "description": "id of the task, whose catalog this resource tracks", "type": "string", "example": "ef8195b7-5ca6-4aca-a3fc-df6ffd58892d" }, "updated_at": { "description": "timestamp of the last update of the catalog", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "updated_by": { "description": "uuid of the user who last updated the catalog", "type": "string", "example": "0ada9483-e3ed-4f31-8a69-372686966451" } } }, "clerk.CloudDelivery": { "type": "object", "required": [ "config" ], "properties": { "config": { "description": "id of the store", "type": "string", "example": "9af9ca14-8c0f-4b7b-ab5e-3a29fc7325b6" }, "path": { "description": "prefix path to which resource should be transferred to", "type": "string", "example": "path/subdirectory1/" } } }, "clerk.CreateDeliveryRequest": { "type": "object", "required": [ "deliveries" ], "properties": { "deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.DeliveryRequest" } } } }, "clerk.Delivery": { "type": "object", "properties": { "catalog_id": { "description": "id of the catalog, whose delivery this resource tracks", "type": "string", "example": "47435e2b-d8c4-51ff-9de9-2be3bfc92276" }, "cloud_delivery": { "description": "cloud delivery configuration for the delivery resource", "allOf": [ { "$ref": "#/components/schemas/clerk.CloudDelivery" } ] }, "created_at": { "description": "timestamp of the creation of the delivery resource", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "created_by": { "description": "uuid of the user who created the delivery resource", "type": "string", "example": "60795589-8759-4d00-9162-b1537b66fb3e" }, "delivery_id": { "description": "id of the delivery", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3cfc92276" }, "status": { "description": "status of the delivery resource", "allOf": [ { "$ref": "#/components/schemas/clerk.DeliveryStatus" } ], "example": "SUCCESS" }, "target_path": { "description": "target path where the resource is delivered, add the cloud_config path and target_path to get the actual path of the resource", "type": "string", "example": "order_1/catalogs.zip" }, "task_id": { "description": "id of the task, whose delivery this resource tracks. The task_id is set only for automated deliveries. Manual deliveries would have the task_id set as null.", "type": "string", "example": "7f74a393-236f-4e02-9d22-b11dea4eac8a" }, "updated_at": { "description": "timestamp of the last update of the delivery resource", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "updated_by": { "description": "uuid of the user who last updated the delivery resource", "type": "string", "example": "b23d9181-4de1-4856-950b-e83b2ac52830" } } }, "clerk.DeliveryRequest": { "type": "object", "required": [ "catalog_ids", "cloud_info", "order_item_ids" ], "properties": { "catalog_ids": { "description": "do not supply order_item_ids if this field is used", "type": "array", "uniqueItems": true, "items": { "type": "string" }, "example": [ "47435e2b-d8c4-51ff-9de9-2be3bfc92276" ] }, "cloud_info": { "$ref": "#/components/schemas/clerk.CloudDelivery" }, "order_item_ids": { "description": "do not supply catalog_ids if this field is used", "type": "array", "uniqueItems": true, "items": { "type": "string" } } } }, "clerk.DeliveryStatus": { "type": "string", "enum": [ "UNSPECIFIED", "CREATED", "FAILED", "IN_PROGRESS", "SUCCESS" ], "x-enum-varnames": [ "DeliveryStatusUnspecified", "DeliveryStatusCreated", "DeliveryStatusFailed", "DeliveryStatusInProgress", "DeliveryStatusSuccess" ] }, "clerk.DownloadRequest": { "type": "object", "required": [ "catalog_ids", "order_item_ids" ], "properties": { "catalog_ids": { "description": "do not supply order_item_ids if this field is used", "type": "array", "uniqueItems": true, "items": { "type": "string" }, "example": [ "47435e2b-d8c4-51ff-9de9-2be3bfc92276" ] }, "order_item_ids": { "description": "do not supply catalog_ids if this field is used", "type": "array", "uniqueItems": true, "items": { "type": "string" } } } }, "clerk.DownloadResponse": { "type": "object", "properties": { "id": { "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "signed_url": { "type": "string", "example": "http://signed_url_link" }, "status": { "allOf": [ { "$ref": "#/components/schemas/clerk.DownloadStatus" } ], "example": "success" } } }, "clerk.DownloadStatus": { "type": "string", "enum": [ "success", "created", "failed", "in_progress" ], "x-enum-varnames": [ "DownloadStatusSuccess", "DownloadStatusCreated", "DownloadStatusFailed", "DownloadStatusInProgress" ] }, "clerk.EoBand": { "type": "object", "properties": { "center_wavelength": { "type": "number" }, "common_name": { "type": "string" }, "fwhm": { "type": "number" }, "name": { "type": "string" } } }, "clerk.Error": { "type": "object", "properties": { "code": { "description": "short string based code reflecting the type of error", "type": "string" }, "details": { "description": "additional details on the error" }, "message": { "description": "info message on the error", "type": "string" } } }, "clerk.ErrorResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/clerk.Error" } } }, "clerk.Geometry": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } } }, "type": { "type": "string", "example": "Polygon" } } }, "clerk.Image": { "type": "object", "properties": { "geometry": {}, "item_id": { "description": "STAC item id for the image", "type": "string" } } }, "clerk.Interval": { "type": "object", "properties": { "end": { "description": "end time of the interval", "type": "string", "example": "2020-01-01T00:00:00+00:00" }, "start": { "description": "start time of the interval", "type": "string", "example": "2020-01-01T00:00:00+00:00" } } }, "clerk.Link": { "type": "object", "properties": { "href": { "type": "string" }, "rel": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } } }, "clerk.ListBandsets": { "type": "object", "properties": { "bandsets": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.Bandset" } } } }, "clerk.ListDeliveries": { "type": "object", "properties": { "deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.Delivery" } } } }, "clerk.ListOrderItemsResponse": { "type": "object", "properties": { "order_items": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.OrderItemResponse" } }, "pagination": { "$ref": "#/components/schemas/common.Pagination" } } }, "clerk.ListOrdersResponse": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.Order" } }, "pagination": { "$ref": "#/components/schemas/common.Pagination" } } }, "clerk.Order": { "type": "object", "properties": { "created_at": { "type": "string", "example": "2020-01-01T00:00:00+00:00" }, "created_by": { "description": "uuid of the user who created the order", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92270" }, "id": { "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "order_items": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.OrderItem" } }, "org_id": { "type": "string", "example": "e31ab6f8-d359-4c6a-83c6-bfa32229bb01" }, "paid_at": { "type": "string", "example": "" }, "status": { "description": "payment status of the order PAID/UNPAID/PAYMENT_IN_PROGRESS", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderStatus" } ], "example": "PAID" }, "total_amount": { "type": "number", "example": 1000 }, "transaction_id": { "type": "string", "example": "3671066b-c4fd-4201-8e02-470cb6bc088e" }, "updated_at": { "type": "string", "example": "2020-01-01T00:00:00+00:00" }, "updated_by": { "description": "uuid of the user who last updated the order", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92270" }, "user_id": { "type": "string", "example": "90afd20d-8447-4636-a60d-73102008856c" } } }, "clerk.OrderItem": { "type": "object", "properties": { "area": { "description": "UTM based area of the current order in sq. km.", "type": "integer", "example": 1000 }, "bandset": { "description": "bandset configuration for the current order", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemBandset" } ] }, "base_amount": { "description": "base amount of the order item without any uplifts or discounts", "type": "number", "example": 10000 }, "cloud_cover": { "description": "maximum cloud cover percentage for the tasking order", "type": "integer", "example": 0 }, "cloud_delivery": { "description": "cloud delivery configuration for the automated delivery of the current order", "allOf": [ { "$ref": "#/components/schemas/clerk.CloudDelivery" } ] }, "created_at": { "description": "timestamp of the creation of the order item", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "created_by": { "description": "uuid of the user who created the order item", "type": "string", "example": "b64d2c37-89c3-404d-8395-dedb0fe9131c" }, "delivery_speed": { "description": "delivery speed of the tasking order", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemDeliverySpeed" } ], "example": "STANDARD" }, "end_date": { "description": "end date of your tasking order, the utc date will be considered as the end date.", "type": "string", "example": "2020-10-28T00:00:00Z" }, "feasibility_status": { "description": "(only for tasking) feasibility status of the order showing the probability of the actual capture", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemFeasibilityStatus" } ], "example": "FAILED/WEAK_SUCCESS/SUCCESS" }, "final_amount": { "description": "final amount of the order item after applying uplifts and discounts", "type": "number", "example": 12000 }, "id": { "description": "unique identifier of the order item", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "image_type": { "description": "image type for the tasking order", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemImageType" } ], "example": "VNIR" }, "images": { "description": "list of images associated with the order item", "type": "array", "items": { "$ref": "#/components/schemas/clerk.Image" } }, "last_feasibility_check": { "description": "(only for tasking) timestamp of the feasibility status. Feasibility status can change wrt time for the same order.", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "name": { "description": "name of the order item", "type": "string", "example": "order item 1" }, "no_of_occurrences": { "description": "number of occurrences of the recurring order.", "type": "integer", "example": 0 }, "number_of_bands": { "description": "number of bands in the tasking order", "type": "integer", "example": 2 }, "occurrences": { "description": "list of intervals of recurring orders.", "type": "array", "items": { "$ref": "#/components/schemas/clerk.Interval" } }, "off_nadir": { "description": "maximum off nadir angle for the tasking order", "type": "integer", "example": 0 }, "order_id": { "description": "UUID of the order", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "org_id": { "description": "UUID of the workspace", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "payment_status": { "description": "payment status of the order item", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemPaymentStatus" } ], "example": "PAID/PARTIAL-REFUND/REFUND/UNPAID/PARTIAL-MONTHLY" }, "project_id": { "description": "UUID of the project", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "recurrence": { "description": "recurrence of the order item, (only for tasking and recurring orders)", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemRecurrence" } ], "example": "ONCE" }, "start_date": { "description": "start date of your tasking order, the utc date will be considered as the start date.", "type": "string", "example": "2020-10-22T00:00:00Z" }, "status": { "description": "status of the order item", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemStatus" } ], "example": "DRAFT/ACTIVE/FULFILLED/CANCELLED/FAILED/PARTIALLY_FULFILLED" }, "tokens_used": { "description": "tokens used by the order item, populated only after payment", "type": "integer", "example": 100 }, "transaction_id": { "description": "transaction id assorciated with the order item", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "type": { "description": "type of the order item", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemType" } ], "example": "TASKING/ARCHIVE/RECURRING" }, "updated_at": { "description": "timestamp of the last update of the order item", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "updated_by": { "description": "uuid of the user who last updated the order item", "type": "string", "example": "274a30f5-9ff2-4cc7-8680-7b2e076b9faf" }, "uplifts": { "description": "list of uplifts/discounts applied to the order", "type": "array", "items": { "$ref": "#/components/schemas/clerk.Uplift" } }, "usecase": { "description": "usecase for which this order was requested", "type": "string", "example": "agriculture" }, "user_id": { "description": "UUID of the user", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" } } }, "clerk.OrderItemBandset": { "type": "object", "properties": { "bands": { "description": "list of bands in the bandset", "type": "array", "items": { "$ref": "#/components/schemas/clerk.Band" } }, "bandset_id": { "description": "id of the bandset", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "custom": { "type": "array", "items": { "type": "array", "items": { "type": "integer" } } } } }, "clerk.OrderItemDeliverySpeed": { "type": "string", "enum": [ "STANDARD", "NOT_APPLICABLE" ], "x-enum-varnames": [ "OrderItemDeliverySpeedStandard", "OrderItemDeliverySpeedNotApplicable" ] }, "clerk.OrderItemFeasibilityStatus": { "type": "string", "enum": [ "NOT_APPLICABLE", "FAILED", "WEAK_SUCCESS", "SUCCESS", "UNSPECIFIED" ], "x-enum-varnames": [ "OrderItemFeasibilityStatusNotApplicable", "OrderItemFeasibilityStatusFailed", "OrderItemFeasibilityStatusWeakSuccess", "OrderItemFeasibilityStatusSuccess", "OrderItemFeasibilityStatusUnspecified" ] }, "clerk.OrderItemImageType": { "type": "string", "enum": [ "VNIR", "SWIR", "VSWIR" ], "x-enum-varnames": [ "OrderItemImageTypeVNIR", "OrderItemImageTypeSWIR", "OrderItemImageTypeVSWIR" ] }, "clerk.OrderItemPaymentStatus": { "type": "string", "enum": [ "PAID", "PARTIAL-REFUND", "REFUND", "UNPAID", "PARTIAL-MONTHLY" ], "x-enum-varnames": [ "OrderItemPaymentStatusPaid", "OrderItemPaymentStatusPartialRefund", "OrderItemPaymentStatusRefund", "OrderItemPaymentStatusUnpaid", "OrderItemPaymentStatusPartialMonthly" ] }, "clerk.OrderItemRecurrence": { "type": "string", "enum": [ "ONCE", "MONTHLY", "BIMONTHLY", "QUARTERLY", "NOT_APPLICABLE" ], "x-enum-varnames": [ "OrderItemRecurrenceOnce", "OrderItemRecurrenceMonthly", "OrderItemRecurrenceBimonthly", "OrderItemRecurrenceQuarterly", "OrderItemRecurrenceNotApplicable" ] }, "clerk.OrderItemResponse": { "type": "object", "properties": { "area": { "description": "UTM based area of the current order in sq. km.", "type": "integer", "example": 1000 }, "bandset": { "description": "bandset configuration for the current order", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemBandset" } ] }, "base_amount": { "description": "base amount of the order item without any uplifts or discounts", "type": "number", "example": 10000 }, "cloud_cover": { "description": "maximum cloud cover percentage for the tasking order", "type": "integer", "example": 0 }, "cloud_delivery": { "description": "cloud delivery configuration for the automated delivery of the current order", "allOf": [ { "$ref": "#/components/schemas/clerk.CloudDelivery" } ] }, "created_at": { "description": "timestamp of the creation of the order item", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "created_by": { "description": "uuid of the user who created the order item", "type": "string", "example": "b64d2c37-89c3-404d-8395-dedb0fe9131c" }, "delivery_speed": { "description": "delivery speed of the tasking order", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemDeliverySpeed" } ], "example": "STANDARD" }, "end_date": { "description": "end date of your tasking order, the utc date will be considered as the end date.", "type": "string", "example": "2020-10-28T00:00:00Z" }, "feasibility_status": { "description": "(only for tasking) feasibility status of the order showing the probability of the actual capture", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemFeasibilityStatus" } ], "example": "FAILED/WEAK_SUCCESS/SUCCESS" }, "final_amount": { "description": "final amount of the order item after applying uplifts and discounts", "type": "number", "example": 12000 }, "id": { "description": "unique identifier of the order item", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "image_type": { "description": "image type for the tasking order", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemImageType" } ], "example": "VNIR" }, "images": { "description": "list of images associated with the order item", "type": "array", "items": { "$ref": "#/components/schemas/clerk.Image" } }, "last_feasibility_check": { "description": "(only for tasking) timestamp of the feasibility status. Feasibility status can change wrt time for the same order.", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "name": { "description": "name of the order item", "type": "string", "example": "order item 1" }, "no_of_occurrences": { "description": "number of occurrences of the recurring order.", "type": "integer", "example": 0 }, "number_of_bands": { "description": "number of bands in the tasking order", "type": "integer", "example": 2 }, "occurrences": { "description": "list of intervals of recurring orders.", "type": "array", "items": { "$ref": "#/components/schemas/clerk.Interval" } }, "off_nadir": { "description": "maximum off nadir angle for the tasking order", "type": "integer", "example": 0 }, "order_id": { "description": "UUID of the order", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "org_id": { "description": "UUID of the workspace", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "payment_status": { "description": "payment status of the order item", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemPaymentStatus" } ], "example": "PAID/PARTIAL-REFUND/REFUND/UNPAID/PARTIAL-MONTHLY" }, "project_id": { "description": "UUID of the project", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "recurrence": { "description": "recurrence of the order item, (only for tasking and recurring orders)", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemRecurrence" } ], "example": "ONCE" }, "start_date": { "description": "start date of your tasking order, the utc date will be considered as the start date.", "type": "string", "example": "2020-10-22T00:00:00Z" }, "status": { "description": "status of the order item", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemStatus" } ], "example": "DRAFT/ACTIVE/FULFILLED/CANCELLED/FAILED/PARTIALLY_FULFILLED" }, "tasks": { "description": "list of tasks associated with the order item", "type": "array", "items": { "$ref": "#/components/schemas/clerk.Task" } }, "tokens_used": { "description": "tokens used by the order item, populated only after payment", "type": "integer", "example": 100 }, "transaction_id": { "description": "transaction id assorciated with the order item", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "type": { "description": "type of the order item", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemType" } ], "example": "TASKING/ARCHIVE/RECURRING" }, "updated_at": { "description": "timestamp of the last update of the order item", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "updated_by": { "description": "uuid of the user who last updated the order item", "type": "string", "example": "274a30f5-9ff2-4cc7-8680-7b2e076b9faf" }, "uplifts": { "description": "list of uplifts/discounts applied to the order", "type": "array", "items": { "$ref": "#/components/schemas/clerk.Uplift" } }, "usecase": { "description": "usecase for which this order was requested", "type": "string", "example": "agriculture" }, "user_id": { "description": "UUID of the user", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "validation_errors": { "description": "list of validation errors for the order item", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } } }, "clerk.OrderItemStatus": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "FULFILLED", "CANCELLED", "FAILED", "PARTIALLY_FULFILLED" ], "x-enum-varnames": [ "OrderItemStatusDraft", "OrderItemStatusActive", "OrderItemStatusFulfilled", "OrderItemStatusCancelled", "OrderItemStatusFailed", "OrderItemStatusPartiallyFulfilled" ] }, "clerk.OrderItemType": { "type": "string", "enum": [ "TASKING", "ARCHIVE", "RECURRING" ], "x-enum-varnames": [ "OrderItemTypeTasking", "OrderItemTypeArchive", "OrderItemTypeRecurring" ] }, "clerk.OrderStatus": { "type": "string", "enum": [ "PAID", "REFUND", "UNPAID", "PAYMENT_IN_PROGRESS" ], "x-enum-varnames": [ "OrderStatusPaid", "OrderStatusRefund", "OrderStatusUnpaid", "OrderStatusPaymentInProgress" ] }, "clerk.Properties": { "type": "object", "properties": { "constellation": { "description": "name of the constellation", "type": "string" }, "created": { "description": "timestamp of the creation of the image", "type": "string" }, "datetime": { "description": "timestamp of the image", "type": "string" }, "eo:cloud_cover": { "description": "cloud cover percentage", "type": "number" }, "gsd": { "description": "ground sample distance", "type": "integer" }, "instruments": { "description": "list of instruments", "type": "array", "items": { "type": "string" } }, "platform": { "description": "name of the platform", "type": "string" }, "proj:epsg": { "description": "EPSG code of the projection", "type": "integer" }, "proj:shape": { "description": "shape of the projection", "type": "array", "items": { "type": "integer" } }, "proj:transform": { "description": "transform of the projection", "type": "array", "items": { "type": "number" } }, "proj:wkt2": { "description": "WKT2 of the projection", "type": "string" }, "sat:orbit_state": { "description": "orbit state of the satellite", "type": "string" }, "sat:relative_orbit": { "description": "relative orbit number of the satellite", "type": "integer" }, "sci:doi": { "description": "DOI of the scientific publication", "type": "string" }, "updated": { "description": "timestamp of the last update of the image", "type": "string" }, "view:off_nadir": { "description": "off nadir angle of the satellite", "type": "number" }, "view:satellite_look_angle": { "description": "look angle of the satellite", "type": "number" }, "view:sun_azimuth": { "description": "azimuth angle of the sun", "type": "number" }, "view:sun_elevation": { "description": "elevation angle of the sun", "type": "number" } } }, "clerk.STACItem": { "type": "object", "properties": { "assets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/clerk.Asset" } }, "bbox": { "description": "bounding box of the STAC item", "type": "array", "items": { "type": "number" } }, "collection": { "type": "string" }, "geometry": { "$ref": "#/components/schemas/clerk.Geometry" }, "id": { "description": "id of the STAC item, also referred as item_id", "type": "string" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.Link" } }, "properties": { "$ref": "#/components/schemas/clerk.Properties" }, "stac_extensions": { "description": "list of extensions used in the STAC item", "type": "array", "items": {} }, "stac_version": { "description": "version of the STAC standard used", "type": "string" }, "type": { "description": "type of the STAC item", "type": "string" } } }, "clerk.SearchCatalogsResponse": { "type": "object", "properties": { "catalogs": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.Catalog" } }, "pagination": { "$ref": "#/components/schemas/common.Pagination" } } }, "clerk.SortingOrder": { "type": "string", "enum": [ "ASC", "DESC" ], "x-enum-varnames": [ "AscendingSortingOrder", "DescendingSortingOrder" ] }, "clerk.Task": { "type": "object", "properties": { "created_at": { "description": "timestamp of the creation of the task", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "created_by": { "description": "uuid of the user who created the task", "type": "string", "example": "e3ff4960-2d5a-4737-90dd-9cfb31bfa71e" }, "delivery_status": { "description": "tracks status of the delivery of the task if automated delivery was configured.", "enum": [ "PENDING", "SUCCESSFUL", "FAILED", "NOT_APPLICABLE" ], "allOf": [ { "$ref": "#/components/schemas/clerk.DeliveryStatus" } ], "example": "SUCCESSFUL" }, "end_date": { "description": "relevant only for tasking", "type": "string", "example": "25-05-2024" }, "id": { "description": "uuid of the task", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "number_of_strips": { "description": "(relevant only for tasking) number of strips generated for the task", "type": "integer", "example": 4 }, "order_item_id": { "description": "uuid of the order item", "type": "string", "example": "TD1_006800_20230528_L2A_20230615_03001067" }, "start_date": { "description": "relevant only for tasking", "type": "string", "example": "15-05-2024" }, "status": { "description": "status of the task", "allOf": [ { "$ref": "#/components/schemas/clerk.TaskStatus" } ], "example": "FULFILLED" }, "tokens_used": { "description": "tokens used by the specific task, for recurring tasking, tokens are consumed on task level and not orderitem level.", "type": "integer", "example": 10 }, "transaction_id": { "description": "uuid of the transaction associated with the task, transaction id will be different for tasks of recurring order items, since each task is transacted for when it's requested/created.", "type": "string", "example": "47435e2b-d8c4-41ff-9de9-2be3bfc92276" }, "type": { "description": "type of the task", "allOf": [ { "$ref": "#/components/schemas/clerk.TaskType" } ], "example": "ARCHIVE" }, "updated_at": { "description": "timestamp of the last update of the task", "type": "string", "example": "2024-05-27T06:50:20.056549Z" }, "updated_by": { "description": "uuid of the user who last updated the task", "type": "string", "example": "77345b90-0677-4889-b4d8-2ddb93c0467f" } } }, "clerk.TaskStatus": { "type": "string", "enum": [ "DRAFT", "SUBMITTED", "IN_PROGRESS", "FULFILLED", "PARTIALLY_FULFILLED", "FAILED", "CANCELLED", "EXPIRED" ], "x-enum-varnames": [ "TaskStatusDraft", "TaskStatusSubmitted", "TaskStatusInProgress", "TaskStatusFulfilled", "TaskStatusPartiallyFulfilled", "TaskStatusFailed", "TaskStatusCancelled", "TaskStatusExpired" ] }, "clerk.TaskType": { "type": "string", "enum": [ "ARCHIVE", "TASKING" ], "x-enum-varnames": [ "TaskTypeArchive", "TaskTypeTasking" ] }, "clerk.Uplift": { "type": "object", "properties": { "amount": { "description": "delta amount due to the uplift", "type": "integer" }, "item_id": { "description": "(only for archive order) the item id to which the uplift applies", "type": "string" }, "percentage": { "description": "percentage of the uplift", "type": "integer" }, "subtitle": { "description": "description of the uplift", "type": "string" }, "title": { "description": "type/cause of the uplift", "type": "string" } } }, "clerk.docOriginalOrderItem": { "type": "object", "required": [ "geometry", "project_id", "usecase" ], "properties": { "project_id": { "type": "string", "x-order": "100", "example": "1234567890" }, "name": { "type": "string", "maxLength": 100, "x-order": "101", "example": "Order Item 1" }, "geometry": { "description": "`required for tasking and archive orders`\nExample\n```\n{\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"properties\": {},\n \"geometry\": {\n \"coordinates\": [\n [\n [\n -102.41263671019601,\n 34.221627630943814\n ],\n [\n -102.41263671019601,\n 34.189892538147575\n ],\n [\n -102.28599400714128,\n 34.189892538147575\n ],\n [\n -102.28599400714128,\n 34.221627630943814\n ],\n [\n -102.41263671019601,\n 34.221627630943814\n ]\n ]\n ],\n \"type\": \"Polygon\"\n }\n }\n ]\n}\n```", "type": "object", "properties": { "features": { "type": "array", "items": { "type": "object", "properties": { "geometry": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } } }, "type": { "type": "string", "enum": [ "Polygon", "MultiPolygon" ] } } }, "type": { "type": "string", "enum": [ "Feature" ] } } } }, "type": { "type": "string", "enum": [ "FeatureCollection" ] } }, "x-order": "102" }, "recurrence": { "description": "`required for tasking`", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemRecurrence" } ], "x-order": "103", "example": "ONCE" }, "start_date": { "description": "`required for tasking` start date of your tasking order, the utc date will be considered as the start date and is inclusive of the interval", "type": "string", "x-order": "104", "example": "2020-10-22T00:00:00Z" }, "end_date": { "description": "`required for tasking` end date of your tasking order, the utc date will be considered as the end date and exclusive of the interval\nExample for a start_date :\"2020-10-22T00:00:00Z\" and end_date \"2020-10-28T00:00:00Z\" dates 22, 23, 24, 25, 26, 27 will be considered for capture.", "type": "string", "x-order": "105", "example": "2020-10-28T00:00:00Z" }, "no_of_occurrences": { "description": "`tasking` in case of recurring orders ie , either one of no_of_occurrences or end_date should be specified.", "type": "integer", "x-order": "106", "example": 0 }, "cloud_cover": { "description": "`tasking` default: 20", "type": "integer", "x-order": "107", "example": 20 }, "off_nadir": { "description": "`tasking` default: 20", "type": "integer", "x-order": "108", "example": 20 }, "bandset": { "type": "object", "properties": { "bandset_id": { "description": "`required for tasking`", "type": "string" } }, "x-order": "109" }, "delivery_speed": { "description": "`tasking` default: STANDARD", "allOf": [ { "$ref": "#/components/schemas/clerk.OrderItemDeliverySpeed" } ], "x-order": "110", "example": "STANDARD" }, "usecase": { "type": "string", "x-order": "111", "example": "agriculture" }, "item_ids": { "description": "`required for archive`", "type": "array", "items": { "type": "string" }, "x-order": "112" }, "cloud_delivery": { "type": "object", "properties": { "config": { "description": "store id", "type": "string", "example": "d5f40033-4abd-48a1-a2f1-276df6edfeaf" }, "path": { "description": "path to deliver the images to", "type": "string", "example": "my-bucket/my-folder" } }, "x-order": "113" } } }, "clerk.docOriginalOrderRequest": { "type": "object", "required": [ "order_items" ], "properties": { "dry_run": { "description": "default is false", "type": "boolean", "x-order": "1", "example": false }, "order_items": { "type": "array", "items": { "$ref": "#/components/schemas/clerk.docOriginalOrderItem" }, "x-order": "2" } } }, "clerk.originalCatalogFilter": { "type": "object", "properties": { "bbox": { "description": "Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four numbers:\n\nLower left: (Latitude 1, Longitude1)\nUpper right: (Latitude 2, Longitude 2)\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs.\n\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).\n\nIf a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.\n\nExample: The bounding box of the New Zealand Exclusive Economic Zone in WGS 84 (from 160.6\u00b0E to 170\u00b0W and from 55.95\u00b0S to 25.89\u00b0S) would be represented in JSON as [160.6, -55.95, -170, -25.89] and in a query as bbox=160.6,-55.95,-170,-25.89", "type": "array", "items": { "type": "number" }, "example": [ 160.6, -55.95, -170, -25.89 ] }, "collections": { "description": "Array of Collection IDs to include in the search for items. Only Item objects in one of the provided collections will be searched.", "type": "array", "items": { "type": "string" } }, "datetime": { "description": "Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.\n\nExamples:\n\nA date-time: \"2018-02-12T23:20:50Z\"\nA closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\nOpen intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\nOnly features that have a temporal property that intersects the value of datetime are selected.\n\nIf a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.", "type": "string", "example": "2020-04-05T11:56:49.865Z/2023-06-05T11:56:49.865Z" }, "ids": { "type": "array", "items": { "type": "string" }, "example": [ "47435e2b-d8c4-41ff-9de9-2be3bfc92276" ] }, "intersects": { "description": "pointGeoJSON (object) or multipointGeoJSON (object) or linestringGeoJSON (object) or multilinestringGeoJSON (object) or polygonGeoJSON (object) or multipolygonGeoJSON (object) or geometrycollectionGeoJSON (object) (geometryGeoJSON)\nThe optional intersects parameter filters the result Items in the same way as bbox, only with a GeoJSON Geometry rather than a bbox.", "allOf": [ { "$ref": "#/components/schemas/clerk.Geometry" } ] }, "item_ids": { "description": "STAC Item IDs as present in the archives API", "type": "array", "items": { "type": "string" }, "example": [ "TD1_2024_ABC" ] }, "limit": { "type": "integer", "default": 2, "example": 50 }, "offset": { "type": "integer", "default": 0, "minimum": 0, "example": 50 }, "order_ids": { "type": "array", "items": { "type": "string" }, "example": [ "57435e2b-d8c4-41ff-9de9-2be3bfc92277" ] }, "order_item_ids": { "type": "array", "items": { "type": "string" }, "example": [ "57435e2b-d8c4-41ff-9de9-2be3bfc92278" ] }, "query": { "description": "a query object to search/filter according to the properites of the stac-item\n```\n\"query\": {\n \"cloudcover\": {\n \"gt\": 0,\n \"lt\": 10\n },\n \"bands\": {\n \"eq\": [\n \"RGB\",\n \"B001\",\n \"B002\"\n ]\n }\n }\n ```", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true } }, "sort_by": { "description": "a sortby object to sort the items by the properties of the stac-item\n\"sortby\": [\n{\n \"field\": \"properties->>'datetime'\",\n \"direction\": \"desc\"\n}\n]", "type": "array", "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/clerk.SortingOrder" } } } } }, "common.Error": { "type": "object", "properties": { "code": { "type": "string" }, "details": {}, "message": { "type": "string" } } }, "common.ErrorResponse": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/common.Error" } } }, "common.Pagination": { "type": "object", "properties": { "limit": { "type": "integer", "x-order": "10037", "example": 10 }, "offset": { "type": "integer", "x-order": "10038", "example": 0 }, "total": { "type": "integer", "x-order": "10039", "example": 100 } } }, "cosmos.Asset": { "type": "object", "properties": { "eo:bands": { "description": "Example\n```\n[\n\t{\n\t\t\"fwhm\": 0,\n\t\t\"name\": \"B013\",\n\t\t\"common_name\": \"blue\",\n\t\t\"solar_irradiance\": 1965.25,\n\t\t\"center_wavelength\": 493\n\t}\n]", "type": "array", "items": { "$ref": "#/components/schemas/cosmos.EoBand" } }, "href": { "description": "The HREF of the asset", "type": "string", "example": "https://example.com/asset.tif" }, "raster:bands": { "description": "Example\n```\n[\n\t{\n\t\t\"scale\": 0.00002,\n\t\t\"nodata\": 0,\n\t\t\"offset\": 0,\n\t\t\"spatial_resolution\": 30\n\t}\n]", "type": "array", "items": { "$ref": "#/components/schemas/cosmos.RasterBand" } }, "roles": { "description": "The roles of the asset (e.g., \"data\", \"metadata\")", "type": "array", "items": { "type": "string" }, "example": [ "data", "metadata" ] }, "title": { "description": "A human-readable title for the asset", "type": "string", "example": "Example Asset Title" }, "type": { "description": "The MIME type of the asset", "type": "string", "example": "image/tiff" } } }, "cosmos.EoBand": { "type": "object", "properties": { "center_wavelength": { "description": "The center wavelength of the band in micrometers", "type": "number", "example": 0.443 }, "common_name": { "description": "The common name of the band (e.g., \"coastal\", \"blue\", \"green\")", "type": "string", "example": "coastal" }, "fwhm": { "description": "The full width at half maximum (FWHM) of the band in micrometers", "type": "number", "example": 0.027 }, "name": { "description": "The unique name of the band", "type": "string", "example": "B01" }, "solar_irradiance": { "description": "The solar irradiance at the top of the atmosphere for the band in W/m\u00b2/\u03bcm", "type": "number", "example": 1901 } } }, "cosmos.FeatureCollection": { "type": "object", "properties": { "type": { "description": "The type of the collection", "type": "string", "x-order": "1", "example": "FeatureCollection" }, "features": { "type": "array", "items": { "$ref": "#/components/schemas/cosmos.Item" }, "x-order": "2" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/cosmos.Link" }, "x-order": "3" } } }, "cosmos.Geometry": { "type": "object", "properties": { "type": { "description": "The type of the geometry", "allOf": [ { "$ref": "#/components/schemas/cosmos.GeometryType" } ], "x-order": "30", "example": "Polygon" }, "coordinates": { "x-order": "31" } } }, "cosmos.GeometryType": { "type": "string", "enum": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection" ], "x-enum-varnames": [ "GeometryPoint", "GeometryMultiPoint", "GeometryLineString", "GeometryMultiLineString", "GeometryPolygon", "GeometryMultiPolygon", "GeometryCollection" ] }, "cosmos.Item": { "type": "object", "required": [ "id" ], "properties": { "id": { "description": "The unique identifier of the item", "type": "string", "x-order": "10", "example": "20201211_223832_CS25" }, "type": { "description": "The type of the item", "type": "string", "x-order": "11", "example": "Feature" }, "collection": { "description": "The collection the item belongs to", "type": "string", "x-order": "12", "example": "simple-collection_2" }, "stac_version": { "description": "The version of the STAC specification", "type": "string", "x-order": "13", "example": "1.0.0" }, "stac_extensions": { "description": "The extensions used in the item", "type": "array", "items": { "type": "string" }, "x-order": "14", "example": [ "https://stac-extensions.github.io/eo/v1.0.0/schema.json", "https://stac-extensions.github.io/projection/v1.0.0/schema.json", "https://stac-extensions.github.io/view/v1.0.0/schema.json" ] }, "bbox": { "description": "The bounding box of the item", "type": "array", "items": { "type": "string" }, "x-order": "15", "example": [ "172.91173669923782", "1.3438851951615003", "172.95469614953714", "1.3690476620161975" ] }, "geometry": { "description": "The geometry of the item", "allOf": [ { "$ref": "#/components/schemas/cosmos.Geometry" } ], "x-order": "16" }, "properties": { "allOf": [ { "$ref": "#/components/schemas/cosmos.Properties" } ], "x-order": "17" }, "assets": { "description": "Example\n```\n{\n\t\"B091\": {\n\t\t\"href\": \"\",\n \"type\": \"image/tiff\",\n \"roles\": [\"data\"],\n \"title\": \"B091\",\n \"eo:bands\": [\n\t\t\t{\n\t\t\t\t\"fwhm\": 0,\n \"name\": \"B091\",\n \"solar_irradiance\": 1984.75,\n \"center_wavelength\": 490,\n \"common_name\": \"red\",\n }\n\t\t],\n \"raster:bands\": [\n {\n \"scale\": 0.00002,\n \"nodata\": 0,\n \t\"offset\": 0,\n \t\"spatial_resolution\": 30\n \t}\n\t\t]\n\t},\n\t\"B013\": {\n\t\t\"href\": \"\",\n \t\"type\": \"image/png\",\n \t\"roles\": [\"data\"],\n \t\"title\": \"B013\",\n \t\"eo:bands\": [\n \t\t{\n\t\t\t\t\"fwhm\": 0,\n \t\"name\": \"B013\",\n \t\"common_name\": \"blue\",\n \t\"solar_irradiance\": 1965.25,\n \t\"center_wavelength\": 493\n \t}\n \t],\n \t\"raster:bands\": [\n \t{\n \t\"scale\": 0.00002,\n \t\"nodata\": 0,\n \t\"offset\": 0,\n \t\"spatial_resolution\": 30\n \t}\n \t]\n }\n} // The properties of the item", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/cosmos.Asset" }, "x-order": "18" }, "links": { "description": "The links of the item", "type": "array", "items": { "$ref": "#/components/schemas/cosmos.Link" }, "x-order": "19" } } }, "cosmos.Link": { "type": "object", "required": [ "href", "rel" ], "properties": { "href": { "description": "The URL or reference the link points to", "type": "string", "example": "https://example.com" }, "rel": { "description": "The relationship of the link (e.g., \"self\", \"parent\", \"child\")", "type": "string", "example": "self" }, "title": { "description": "A human-readable title for the link", "type": "string", "example": "Example Link Title" }, "type": { "description": "The MIME type of the linked resource (e.g., \"application/json\")", "type": "string", "example": "application/json" } } }, "cosmos.Properties": { "type": "object", "properties": { "altitude": { "description": "The altitude of the sensor in meters", "type": "number", "example": 700 }, "constellation": { "description": "The constellation name", "type": "string", "example": "TD1" }, "created": { "description": "The date and time the item was created", "type": "string", "example": "2022-01-01T10:00:00Z" }, "datetime": { "type": "string", "example": "2022-06-15T12:00:00Z" }, "description": { "description": "A description of the item", "type": "string", "example": "Example description of the dataset" }, "eo:cloud_cover": { "description": "The percentage of the image covered by clouds", "type": "number", "example": 23.5 }, "gsd": { "description": "The ground sample distance in meters", "type": "number", "example": 30 }, "instruments": { "description": "The instruments used", "type": "array", "items": { "type": "string" }, "example": [ "VNIR" ] }, "license": { "description": "The license of the item", "type": "string", "example": "CC-BY-4.0" }, "platform": { "description": "The platform name", "type": "string", "example": "TD1" }, "proj:code": { "description": "The EPSG code of the projection", "type": "string", "example": "EPSG:4326" }, "proj:shape": { "description": "The shape of the projection", "type": "array", "items": { "type": "integer" }, "example": [ 10980, 10980 ] }, "proj:transform": { "description": "the affine transform coefficients", "type": "array", "items": { "type": "number" }, "example": [ 0, 10, 500000, 0, -10, 1000000 ] }, "rd:anomalous_pixels": { "description": "The percentage of anomalous pixels", "type": "number", "example": 0.01 }, "rd:earth_sun_distance": { "description": "The distance between the Earth and the Sun", "type": "number", "example": 1 }, "rd:product_level": { "description": "The product level", "type": "string", "example": "L2A" }, "rd:sat_id": { "description": "The satellite ID", "type": "string", "example": "SAT-123" }, "rd:type": { "description": "The type of radiometric data", "type": "string", "example": "Reflectance" }, "sci:doi": { "description": "The DOI of the scientific publication", "type": "string", "example": "10.1234/sci_doi" }, "startdatetime": { "type": "string", "example": "2022-01-01T00:00:00Z" }, "title": { "description": "The title of the item", "type": "string", "example": "Example Title" }, "updated": { "description": "The date and time the item was last updated", "type": "string", "example": "2022-06-01T10:00:00Z" }, "view:off_nadir": { "description": "The angle between the sensor and the vertical", "type": "number", "example": 5 }, "view:scene_center_lat": { "description": "The latitude of the center of the scene", "type": "number", "example": 12.3456 }, "view:scene_center_lon": { "description": "The longitude of the center of the scene", "type": "number", "example": -76.5432 }, "view:sun_azimuth": { "description": "The angle between the sun and the north", "type": "number", "example": 135 }, "view:sun_elevation": { "description": "The angle between the sun and the horizon", "type": "number", "example": 45 } } }, "cosmos.RasterBand": { "type": "object", "properties": { "nodata": { "description": "The nodata value of the band", "type": "number", "example": -9999 }, "offset": { "description": "The offset of the band", "type": "number", "example": 0 }, "scale": { "description": "The scale of the band", "type": "number", "example": 1 }, "spatial_resolution": { "description": "The spatial resolution of the band in meters", "type": "number", "example": 10 } } }, "cosmos.Search": { "type": "object", "properties": { "bbox": { "description": "Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four numbers:\n\nLower left corner, coordinate axis 1\nLower left corner, coordinate axis 2\nUpper right corner, coordinate axis 1\nUpper right corner, coordinate axis 2\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs.\n\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).\n\nIf a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.\n\nExample: The bounding box of the New Zealand Exclusive Economic Zone in WGS 84 (from 160.6\u00b0E to 170\u00b0W and from 55.95\u00b0S to 25.89\u00b0S) would be represented in JSON as [160.6, -55.95, -170, -25.89] and in a query as bbox=160.6,-55.95,-170,-25.89", "type": "array", "items": { "type": "number" }, "example": [ 3, 4, 5, 6 ] }, "collections": { "description": "Array of Collection IDs to include in the search for items. Only Item objects in one of the provided collections will be searched.", "type": "array", "items": { "type": "string" } }, "datetime": { "description": "Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.\n\nExamples:\n\nA date-time: \"2018-02-12T23:20:50Z\"\nA closed interval: \"2018-02-12T00:00:00Z/2018-03-18T12:31:12Z\"\nOpen intervals: \"2018-02-12T00:00:00Z/..\" or \"../2018-03-18T12:31:12Z\"\nOnly features that have a temporal property that intersects the value of datetime are selected.\n\nIf a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.", "type": "string", "example": "2020-04-05T11:56:49.865Z/2023-06-05T11:56:49.865Z" }, "ids": { "type": "array", "items": { "type": "string" } }, "intersects": { "description": "pointGeoJSON (object) or multipointGeoJSON (object) or linestringGeoJSON (object) or multilinestringGeoJSON (object) or polygonGeoJSON (object) or multipolygonGeoJSON (object) or geometrycollectionGeoJSON (object) (geometryGeoJSON)\nThe optional intersects parameter filters the result Items in the same was as bbox, only with a GeoJSON Geometry rather than a bbox.", "allOf": [ { "$ref": "#/components/schemas/cosmos.Geometry" } ] }, "limit": { "type": "integer", "default": 10, "example": 10 }, "offset": { "type": "integer", "example": 0 }, "query": { "description": "a query object to search/filter according to the properites of the stac-item\n `\"query\": {\n \"cloudcover\": {\n \"gt\": 0,\n \"lt\": 10\n },\n \"bands\": {\n \"eq\": [\n \"RGB\",\n \"B001\",\n \"B002\"\n ]\n }\n },`", "type": "object", "additionalProperties": { "type": "object", "additionalProperties": true } }, "sortby": { "description": "a sortby object to sort the items by the properties of the stac-item\n\"sortby\": [\n{\n \"field\": \"properties->>'datetime'\",\n \"direction\": \"desc\"\n}\n]", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } } } }, "cosmos.modifiedSuccessResponse": { "type": "object", "properties": { "collections": { "type": "array", "items": { "$ref": "#/components/schemas/cosmos.originalCollectionSuccessResponse" } } } }, "cosmos.originalCollectionSuccessResponse": { "type": "object", "properties": { "created_at": { "type": "string", "example": "2023-08-06T20:46:56.815552Z" }, "description": { "type": "string", "example": "A collection description" }, "extent": { "type": "object", "properties": { "spatial": { "type": "object", "properties": { "bbox": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } } } }, "temporal": { "type": "object", "properties": { "interval": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } } } } }, "id": { "type": "string", "example": "pixxel-dd2" }, "license": { "type": "string", "example": "proprietary" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/cosmos.Link" } }, "providers": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "example": "Pixxel is a space data company" }, "name": { "type": "string", "example": "Pixxel" }, "roles": { "type": "array", "items": { "type": "string" }, "example": [ "producer" ] }, "url": { "type": "string", "example": "https://pixxel.space" } } } }, "stac_extensions": {}, "stac_version": { "type": "string", "example": "0.1.0" }, "summaries": {}, "title": { "type": "string", "example": "Pixxel-DD01" }, "type": { "type": "string", "example": "Collection" }, "updated_at": { "type": "string", "example": "2023-08-06T20:46:56.815552Z" } } }, "courier.CreateStoreRequest": { "type": "object", "required": [ "configs", "name", "secrets", "type" ], "properties": { "name": { "description": "Unique user friendly name for easier identification", "type": "string", "x-order": "10", "example": "my-analysis-store" }, "type": { "description": "Type of bucket depending on the cloud provider. Currently Supported - S3, AZBLOB, GCS", "allOf": [ { "$ref": "#/components/schemas/domain.BucketType" } ], "x-order": "20", "example": "S3" }, "configs": { "allOf": [ { "$ref": "#/components/schemas/domain.StoreConfigs" } ], "x-order": "30" }, "secrets": { "description": "Credentials to be used for transferring data to specified bucket\nThese vary for each cloud provider -\n\t\t- **S3** - `access_key_id`, `secret_access_key`\n\t\t- **AZBLOB** - `account_name`, `tenant_id`, `client_id`, `client_secret`\n\t\t- **GCS** - `project_id`, `service_account_credentials`", "type": "object", "additionalProperties": { "type": "string" }, "x-order": "40" }, "labels": { "description": "User defined labels for metadata", "type": "object", "additionalProperties": { "type": "string" }, "x-order": "50", "example": { "env": "prod", "team": "data" } } } }, "courier.CreateStoreResponse": { "type": "object", "properties": { "id": { "description": "Identifier to be used while transferring data", "type": "string", "x-order": "10", "example": "576d8241-6e78-40ad-b3e6-295edbfe71f5" }, "name": { "description": "Unique user friendly name for easier identification", "type": "string", "x-order": "20", "example": "my-analysis-store" }, "type": { "description": "Type of bucket depending on the cloud provider. Currently Supported - S3, AZBLOB, GCS", "allOf": [ { "$ref": "#/components/schemas/domain.BucketType" } ], "x-order": "30", "example": "S3" }, "configs": { "allOf": [ { "$ref": "#/components/schemas/domain.StoreConfigs" } ], "x-order": "40" }, "labels": { "description": "User defined labels for metadata", "type": "object", "additionalProperties": { "type": "string" }, "x-order": "50", "example": { "env": "prod", "team": "data" } }, "created_at": { "description": "Store creation time", "type": "string", "x-order": "60", "example": "2024-03-20T15:04:05Z" }, "updated_at": { "description": "Store last updated time", "type": "string", "x-order": "70", "example": "2024-03-20T15:04:05Z" }, "created_by": { "description": "Identifier of the user that created store", "type": "string", "x-order": "80", "example": "ea2a79fc-6f68-40d7-8b79-18195bf74872" } } }, "courier.ListStoresResponse": { "type": "object", "properties": { "stores": { "type": "array", "items": { "$ref": "#/components/schemas/domain.Store" } } } }, "dexter.BlockSpec": { "type": "object", "properties": { "kind": { "description": "Kind specifies the category or classification of the block", "type": "string", "x-order": "10" }, "status": { "description": "Status represents the current state of the block (e.g., active, deprecated)", "type": "integer", "x-order": "100" }, "inputs": { "description": "Inputs defines the expected input parameters in raw JSON format", "type": "array", "items": { "type": "integer" }, "x-order": "110" }, "outputs": { "description": "Outputs defines the produced output values in raw JSON format", "type": "array", "items": { "type": "integer" }, "x-order": "120" }, "catalog_content_url": { "description": "CatalogContentUrl is the URL where additional catalog content can be found", "type": "string", "x-order": "130" }, "supported_collections_id": { "description": "SupportedCollections lists identifiers of collections compatible with this block", "type": "array", "items": { "type": "string" }, "x-order": "140" }, "type": { "description": "Type defines the functional type of the block", "type": "string", "x-order": "20" }, "description": { "description": "Description provides a detailed explanation of the block's purpose and functionality", "type": "string", "x-order": "30" }, "id": { "description": "Id is the unique identifier for this block", "type": "string", "x-order": "50" }, "version_id": { "description": "VersionId identifies the specific version of this block", "type": "string", "x-order": "60" }, "name": { "description": "Name is the canonical name of the block", "type": "string", "x-order": "70" }, "title": { "description": "Title is the display name of the block", "type": "string", "x-order": "80" }, "version": { "description": "Version indicates the current version number of the block", "type": "string", "x-order": "90" } } }, "dexter.BlockSpecItem": { "type": "object", "properties": { "id": { "description": "ID is the unique identifier for this block", "type": "string", "x-order": "10" }, "block_status": { "description": "BlockStatus represents the current state of the block", "type": "string", "x-order": "20" }, "spec": { "description": "Spec contains the block specification", "allOf": [ { "$ref": "#/components/schemas/dexter.BlockSpec" } ], "x-order": "30" }, "created_at": { "description": "CreatedAt indicates when the block was created", "type": "string", "x-order": "40" }, "err": { "description": "Err contains any error information", "type": "string", "x-order": "50" } } }, "dexter.CreateInsightCostEstimateUpstreamResponseBody": { "type": "object", "properties": { "estimate": { "description": "Estimate provides the computed cost value for the insight execution", "type": "integer", "x-order": "10" } } }, "dexter.CreateInsightUpstreamResponseBody": { "type": "object", "properties": { "id": { "description": "Id is the unique identifier assigned to the created insight", "type": "string", "x-order": "10" }, "message": { "description": "Message contains additional information about the insight creation result", "type": "string", "x-order": "20" } } }, "dexter.CreateInsightsWildcardTransformerRequest": { "type": "object", "required": [ "block", "input" ], "properties": { "name": { "description": "Name is a human-readable title for the insight", "type": "string", "x-order": "10" }, "block": { "description": "Describes the processing block to use for the insight", "type": "object", "required": [ "version" ], "properties": { "name": { "description": "Name of the block", "type": "string" }, "string": { "description": "Id is a unique identifier for the block", "type": "string" }, "version": { "description": "Semantic version of the block to use", "type": "string" } }, "x-order": "20" }, "input": { "description": "Inputs to the insight", "type": "array", "items": { "type": "integer" }, "x-order": "30" }, "project_id": { "description": "Identifies which project this insight belongs to", "type": "string", "x-order": "40" }, "metadata": { "description": "Contains additional key-value information about the insight", "type": "object", "additionalProperties": { "type": "string" }, "x-order": "50" }, "estimate": { "description": "Indicates whether to return a cost estimate instead of running the insight.", "type": "boolean", "x-order": "60" } } }, "dexter.GetBlockVersionsTransformerResponse": { "type": "object", "properties": { "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/dexter.BlockSpecItem" }, "x-order": "10" } } }, "dexter.GetJobByIdTransformerResponse": { "type": "object", "properties": { "created_by": { "description": "Unique identifier of the user who created the job", "type": "string", "x-order": "10" }, "status": { "description": "Current status of the job", "type": "string", "x-order": "100" }, "time_taken": { "description": "Total time taken by the job", "type": "string", "x-order": "110" }, "id": { "description": "Unique identifier of the job", "type": "string", "x-order": "120" }, "tasks": { "description": "List of tasks in this job", "type": "array", "items": { "$ref": "#/components/schemas/dexter.PostWorkflowTaskGet" }, "x-order": "130" }, "val_errors": { "description": "Validation errors encountered", "type": "array", "items": { "$ref": "#/components/schemas/dexter.ValError" }, "x-order": "140" }, "spec": { "description": "Raw specification data for the job", "type": "array", "items": { "type": "integer" }, "x-order": "150" }, "cost": { "description": "Computational cost of the job", "type": "integer", "x-order": "160" }, "workflow_id": { "description": "Unique identifier of the workflow this job belongs to", "type": "string", "x-order": "20" }, "updated_at": { "description": "When the job was last updated", "type": "string", "x-order": "30" }, "finished_at": { "description": "When the job was completed", "type": "string", "x-order": "40" }, "exec_created_at": { "description": "When the job execution was created", "type": "string", "x-order": "50" }, "exec_updated_at": { "description": "When the job execution was last updated", "type": "string", "x-order": "60" }, "created_at": { "description": "When the job was created", "type": "string", "x-order": "70" }, "estimated_duration": { "description": "Estimated time in seconds to complete the job", "type": "integer", "x-order": "80" }, "progress": { "description": "Completion percentage of the job", "type": "string", "x-order": "90" } } }, "dexter.GetWorkflowCostEstimateTransformerResponse": { "type": "object", "properties": { "estimated_cost": { "description": "The calculated cost of running the workflow, in credits", "type": "integer", "x-order": "10" } } }, "dexter.GetWorkflowsByIdTransformerResponse": { "type": "object", "properties": { "id": { "description": "Unique identifier for the workflow", "type": "string", "x-order": "10" }, "estimated_cost": { "description": "Token cost estimated for this workflow", "type": "integer", "x-order": "100" }, "name": { "description": "Display name of the workflow", "type": "string", "x-order": "20" }, "created_by": { "description": "Identifies the user who created this workflow", "type": "string", "x-order": "30" }, "description": { "description": "Provides details about the workflow's purpose", "type": "string", "x-order": "40" }, "spec": { "description": "Contains the raw specification data for the workflow", "type": "array", "items": { "type": "integer" }, "x-order": "50" }, "created_at": { "description": "Timestamp when the workflow was created", "type": "string", "x-order": "60" }, "updated_at": { "description": "Timestamp when the workflow was last modified", "type": "string", "x-order": "70" }, "val_errors": { "description": "Validation errors encountered with this workflow", "type": "array", "items": { "$ref": "#/components/schemas/dexter.ValError" }, "x-order": "80" }, "project_id": { "description": "Identifier of the project this workflow belongs to", "type": "string", "x-order": "90" } } }, "dexter.ListBlocksTransformerResponse": { "type": "object", "properties": { "blocks": { "type": "array", "items": { "$ref": "#/components/schemas/dexter.BlockSpecItem" }, "x-order": "10" } } }, "dexter.ListInsightItem": { "type": "object", "properties": { "name": { "description": "Display name of the insight", "type": "string", "x-order": "10" }, "created_at": { "description": "Timestamp when the insight was created", "type": "string", "x-order": "100" }, "err_msg": { "description": "Contains any error message if the insight processing failed", "type": "string", "x-order": "110" }, "created_by": { "description": "Identifies the user who created this insight", "type": "string", "x-order": "120" }, "estimated_time_in_min": { "description": "Expected processing time in minutes", "type": "integer", "x-order": "130" }, "deleted_at": { "description": "Timestamp when the insight was deleted, null if not deleted", "type": "string", "x-order": "140" }, "id": { "description": "Unique identifier for the insight", "type": "string", "x-order": "20" }, "status": { "description": "Represents the current processing status of the insight", "type": "string", "x-order": "30" }, "input": { "description": "Contains the raw input data provided for the insight", "type": "array", "items": { "type": "integer" }, "x-order": "40" }, "output": { "description": "Contains the raw result data generated by the insight", "type": "array", "items": { "type": "integer" }, "x-order": "50" }, "metadata": { "description": "Contains additional key-value information about the insight", "type": "object", "additionalProperties": { "type": "string" }, "x-order": "60" }, "aoi_id": { "description": "Identifier of the area of interest this insight belongs to", "type": "string", "x-order": "70" }, "cost": { "description": "Represents the computational cost or credits used for this insight", "type": "integer", "x-order": "80" }, "progress": { "description": "Indicates the completion percentage of the insight processing", "type": "number", "x-order": "90" } } }, "dexter.ListInsightsTransformerResponse": { "type": "object", "properties": { "insights": { "type": "array", "items": { "$ref": "#/components/schemas/dexter.ListInsightItem" }, "x-order": "10" } } }, "dexter.ListJobsItem": { "type": "object", "properties": { "created_by": { "description": "ID of the user who created the job", "type": "string", "x-order": "10" }, "id": { "description": "unique identifier for the job", "type": "string", "x-order": "100" }, "cost": { "description": "cost of the job", "type": "integer", "x-order": "110" }, "workflow_id": { "description": "unique identifier of the workflow the job belongs to", "type": "string", "x-order": "20" }, "created_at": { "description": "timestamp when the job was created", "type": "string", "x-order": "30" }, "updated_at": { "description": "timestamp when the job was last updated", "type": "string", "x-order": "40" }, "finished_at": { "description": "timestamp when the job was completed", "type": "string", "x-order": "50" }, "estimated_duration": { "description": "expected time to complete the job in seconds", "type": "integer", "x-order": "60" }, "progress": { "description": "current completion percentage of the job", "type": "string", "x-order": "70" }, "status": { "description": "current state of the job", "type": "string", "x-order": "80" }, "time_taken": { "description": "actual duration the job took to complete", "type": "string", "x-order": "90" } } }, "dexter.ListJobsTransformerResponse": { "type": "object", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/dexter.ListJobsItem" }, "x-order": "10" } } }, "dexter.ListWorkflowItem": { "type": "object", "properties": { "id": { "description": "Unique identifier for the workflow", "type": "string", "x-order": "10" }, "project_id": { "description": "Identifier of the project this workflow belongs to", "type": "string", "x-order": "20" }, "legacy_project_id": { "description": "Identifier of the project in legacy systems", "type": "string", "x-order": "30" }, "name": { "description": "Display name of the workflow", "type": "string", "x-order": "40" }, "created_by": { "description": "Represents the user who created this workflow", "type": "string", "x-order": "50" }, "description": { "description": "Provides additional details about the workflow", "type": "string", "x-order": "60" }, "created_at": { "description": "Timestamp when the workflow was created", "type": "string", "x-order": "70" }, "updated_at": { "description": "Timestamp when the workflow was last modified", "type": "string", "x-order": "80" } } }, "dexter.ListWorkflowsTransformerResponse": { "type": "object", "properties": { "workflows": { "type": "array", "items": { "$ref": "#/components/schemas/dexter.ListWorkflowItem" }, "x-order": "10" }, "pagination": { "allOf": [ { "$ref": "#/components/schemas/common.Pagination" } ], "x-order": "20" } } }, "dexter.PostWorkflowRunTransformerResponse": { "type": "object", "properties": { "created_by": { "description": "Unique identifier of the user who created the job", "type": "string", "x-order": "10" }, "status": { "description": "Current status of the job", "type": "string", "x-order": "100" }, "time_taken": { "description": "Actual duration the job took to complete", "type": "string", "x-order": "110" }, "id": { "description": "Unique identifier for the job", "type": "string", "x-order": "120" }, "tasks": { "description": "List of tasks in this job", "type": "array", "items": { "$ref": "#/components/schemas/dexter.PostWorkflowTaskGet" }, "x-order": "130" }, "val_errors": { "description": "Validation errors encountered", "type": "array", "items": { "$ref": "#/components/schemas/dexter.ValError" }, "x-order": "140" }, "spec": { "description": "Raw specification data for the job", "type": "array", "items": { "type": "integer" }, "x-order": "150" }, "cost": { "description": "Token cost of the job", "type": "integer", "x-order": "160" }, "workflow_id": { "description": "Unique identifier of the workflow this job belongs to", "type": "string", "x-order": "20" }, "updated_at": { "description": "Timestamp when the job was last updated", "type": "string", "x-order": "30" }, "finished_at": { "description": "Timestamp when the job was completed", "type": "string", "x-order": "40" }, "exec_created_at": { "description": "Timestamp when the job execution was created", "type": "string", "x-order": "50" }, "exec_updated_at": { "description": "Timestamp when the job execution was last updated", "type": "string", "x-order": "60" }, "created_at": { "description": "Timestamp when the job was created", "type": "string", "x-order": "70" }, "estimated_duration": { "description": "Expected time in seconds to complete the job", "type": "integer", "x-order": "80" }, "progress": { "description": "Completion percentage of the job", "type": "string", "x-order": "90" } } }, "dexter.PostWorkflowTaskGet": { "type": "object", "properties": { "id": { "description": "Uniquely identifies each task in the workflow execution", "type": "string", "x-order": "10" }, "info_logs": { "description": "Debugging and execution information in raw bytes", "type": "array", "items": { "type": "integer" }, "x-order": "100" }, "created_at": { "description": "Timestamp when the task was initialized", "type": "string", "x-order": "110" }, "updated_at": { "description": "Timestamp of the most recent task modification", "type": "string", "x-order": "120" }, "finished_at": { "description": "Timestamp when task processing ended", "type": "string", "x-order": "130" }, "estimated_time_duration": { "description": "Predicted seconds until task completes", "type": "integer", "x-order": "140" }, "time_taken": { "description": "Actual duration from start to finish", "type": "string", "x-order": "150" }, "status": { "description": "Current execution status of the task", "type": "string", "x-order": "160" }, "state_msg": { "description": "Additional context about the current state", "type": "string", "x-order": "170" }, "inputs": { "description": "Raw JSON data supplied to the task", "type": "array", "items": { "type": "integer" }, "x-order": "180" }, "result": { "description": "Raw JSON output produced by the task", "type": "array", "items": { "type": "integer" }, "x-order": "190" }, "depends_on": { "description": "Lists task names that must finish before this task begins", "type": "array", "items": { "type": "string" }, "x-order": "20" }, "name": { "description": "Descriptive label for the task", "type": "string", "x-order": "200" }, "progress": { "description": "Completion percentage from 0 to 100", "type": "number", "x-order": "210" }, "disclaimer": { "description": "Warnings or notices about task execution", "type": "array", "items": { "type": "string" }, "x-order": "220" }, "recv_time": { "description": "Timestamp when the system received the task request", "type": "string", "x-order": "30" }, "send_time": { "description": "Timestamp when the task was sent for execution", "type": "string", "x-order": "40" }, "block_inf_start_time": { "description": "Marks when inference processing began", "type": "string", "x-order": "50" }, "block_inf_end_time": { "description": "Marks when inference processing completed", "type": "string", "x-order": "60" }, "block_info": { "description": "Describes the block used in the task", "type": "object", "properties": { "id": { "description": "Unique identifier for this block", "type": "string" }, "name": { "description": "Human-friendly block identifier", "type": "string" }, "version": { "description": "Semantic versioning string of the block", "type": "string" } }, "x-order": "70" }, "err_msg": { "description": "Error text returned by the model during execution", "type": "string", "x-order": "80" }, "failure_type": { "description": "Categorizes the specific error that occurred", "type": "string", "x-order": "90" } } }, "dexter.PutInsightsUpstreamRequestBody": { "type": "object", "properties": { "inputs": { "description": "Specifies which input assets to include in the download", "type": "array", "items": { "type": "string" }, "x-order": "10" }, "outputs": { "description": "Specifies which output assets to include in the download", "type": "array", "items": { "type": "string" }, "x-order": "20" } } }, "dexter.PutInsightsUpstreamResponseBody": { "type": "object", "properties": { "id": { "description": "Unique identifier of the insight", "type": "string", "x-order": "10" }, "status": { "description": "Current status of the download operation", "type": "string", "x-order": "20" }, "signed_url": { "description": "URL where the packaged assets can be downloaded from", "type": "string", "x-order": "30" } } }, "dexter.PutJobUpstreamResponseBody": { "type": "object", "properties": { "id": { "description": "Unique identifier of the insight", "type": "string", "x-order": "10" }, "status": { "description": "Current status of the download operation", "type": "string", "x-order": "20" }, "signed_url": { "description": "URL where the packaged assets can be downloaded from", "type": "string", "x-order": "30" }, "workflowId": { "description": "WorkflowId of the Job", "type": "string", "x-order": "40" } } }, "dexter.PutTaskUpstreamResponseBody": { "type": "object", "properties": { "id": { "description": "Id is the unique identifier of the task", "type": "string", "x-order": "10" }, "job_id": { "description": "JobId is the ID of the job", "type": "string", "x-order": "20" }, "workflow_id": { "description": "WorkflowId is the ID of the workflow", "type": "string", "x-order": "30" }, "status": { "description": "Status indicates the current status of the download operation", "type": "string", "x-order": "40" }, "signed_url": { "description": "SignedUrl is the URL where the packaged assets can be downloaded from", "type": "string", "x-order": "50" } } }, "dexter.ValError": { "type": "object", "properties": { "from": { "description": "Source component of the validation error", "type": "string", "x-order": "10" }, "to": { "description": "Target component of the validation error", "type": "string", "x-order": "20" }, "err": { "description": "Error message", "type": "string", "x-order": "30" }, "reason": { "description": "Additional context about why the error occurred", "type": "string", "x-order": "40" }, "component_name": { "description": "Specific component that generated the error", "type": "string", "x-order": "50" } } }, "domain.BucketType": { "type": "string", "enum": [ "S3", "GCS", "AZBLOB" ], "x-enum-varnames": [ "BucketTypeAWSS3", "BucketTypeGCS", "BucketTypeAZBLOB" ] }, "domain.Store": { "type": "object", "properties": { "id": { "description": "Identifier to be used while transferring data", "type": "string", "x-order": "10", "example": "576d8241-6e78-40ad-b3e6-295edbfe71f5" }, "name": { "description": "Unique user friendly name for easier identification", "type": "string", "x-order": "20", "example": "my-analysis-store" }, "type": { "description": "Type of bucket depending on the cloud provider. Currently Supported - S3, AZBLOB, GCS", "allOf": [ { "$ref": "#/components/schemas/domain.BucketType" } ], "x-order": "30", "example": "S3" }, "configs": { "allOf": [ { "$ref": "#/components/schemas/domain.StoreConfigs" } ], "x-order": "40" }, "labels": { "description": "User defined labels for metadata", "type": "object", "additionalProperties": { "type": "string" }, "x-order": "50", "example": { "env": "prod", "team": "data" } }, "created_at": { "description": "Store creation time", "type": "string", "x-order": "60", "example": "2024-03-20T15:04:05Z" }, "updated_at": { "description": "Store last updated time", "type": "string", "x-order": "70", "example": "2024-03-20T15:04:05Z" }, "created_by": { "description": "Identifier of the user that created store", "type": "string", "x-order": "80", "example": "ea2a79fc-6f68-40d7-8b79-18195bf74872" } } }, "domain.StoreConfigs": { "type": "object", "required": [ "bucket", "region" ], "properties": { "bucket": { "description": "Name of the bucket to be used for data transfers", "type": "string", "x-order": "1", "example": "my-data-bucket" }, "region": { "description": "Region as defined by cloud provider", "type": "string", "x-order": "2", "example": "us-east-2" }, "path_prefix": { "description": "Path prefix to be used for all transfers.", "type": "string", "x-order": "3", "example": "data/processed/" } } }, "frontier.getProjectById": { "type": "object", "properties": { "project": { "type": "object", "properties": { "id": { "description": "ID of the project", "type": "string", "x-order": "0" }, "name": { "description": "Project slug", "type": "string", "x-order": "1" }, "title": { "description": "Project name", "type": "string", "x-order": "2" }, "org_id": { "description": "Workspace ID this project belongs to", "type": "string", "x-order": "3" }, "created_at": { "description": "Project creation datetime", "type": "string", "x-order": "4" }, "updated_at": { "description": "Project update datetime", "type": "string", "x-order": "5" }, "metadata": { "description": "Additional data in the form of key-value pairs", "type": "object", "x-order": "6" } } } } }, "frontier.listProjects": { "type": "object", "properties": { "count": { "description": "Total count of records, to be used for pagination", "type": "integer" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "description": "ID of the project", "type": "string", "x-order": "0" }, "name": { "description": "Project slug", "type": "string", "x-order": "1" }, "title": { "description": "Project name", "type": "string", "x-order": "2" }, "org_id": { "description": "Workspace ID this project belongs to", "type": "string", "x-order": "3" }, "members_count": { "description": "Number of users in this project", "type": "integer", "x-order": "4" }, "created_at": { "description": "Project creation datetime", "type": "string", "x-order": "5" }, "updated_at": { "description": "Project update datetime", "type": "string", "x-order": "6" }, "metadata": { "description": "Additional data in the form of key-value pairs", "type": "object", "x-order": "7" } } } } } }, "lens.Filter": { "type": "object", "required": [ "id", "max", "min" ], "properties": { "id": { "description": "eo:cloud_cover", "type": "string", "x-order": "100", "example": "eo:cloud_cover" }, "min": { "description": "0", "type": "integer", "x-order": "101", "example": 0 }, "max": { "description": "100", "type": "integer", "x-order": "102", "example": 100 } } }, "lens.Geometry": { "type": "object", "properties": { "coordinates": { "x-order": "100" }, "type": { "type": "string", "x-order": "101", "example": "Polygon" } } }, "lens.SatelliteInfo": { "type": "object", "required": [ "collection_id", "satellite_id" ], "properties": { "collection_id": { "type": "string", "x-order": "100", "example": "sentinel-2-l2a" }, "satellite_id": { "type": "string", "x-order": "101", "example": "0002a3a3-00a2-4b55-842b-44d8202c6d60" } } }, "lens.V2Query": { "type": "object", "required": [ "end_date", "geometry", "satellites", "start_date" ], "properties": { "start_date": { "type": "string", "x-order": "100", "example": "2023-04-18T11:56:49.865Z" }, "end_date": { "type": "string", "x-order": "101", "example": "2023-05-03T11:56:49.865Z" }, "satellites": { "type": "array", "items": { "$ref": "#/components/schemas/lens.SatelliteInfo" }, "x-order": "103" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/lens.Filter" }, "x-order": "104" }, "geometry": { "allOf": [ { "$ref": "#/components/schemas/lens.Geometry" } ], "x-order": "106" }, "limit": { "type": "integer", "maximum": 10000, "minimum": 1, "x-order": "107", "example": 10 } } }, "lens.V2Response": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/cosmos.Item" }, "x-order": "100" }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer", "x-order": "100", "example": 10 }, "skip": { "type": "integer", "x-order": "101", "example": 0 }, "total": { "type": "integer", "x-order": "102", "example": 100 } }, "x-order": "101" } } }, "lens.modifiedSuccessResponse": { "type": "object", "properties": { "satellites": { "type": "array", "items": { "$ref": "#/components/schemas/lens.originalSuccessResponse" } } } }, "lens.originalSuccessResponse": { "type": "object", "properties": { "bands": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "offset": { "type": "number" }, "scale": { "type": "number" }, "spatial_resolution": { "type": "integer" }, "wavelength": { "type": "number" } } } }, "collections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "queryables": { "type": "array", "items": { "type": "string" } }, "rescale": { "type": "array", "items": { "type": "integer" } } } } }, "id": { "type": "string" }, "name": { "type": "string" }, "rgb_composite": { "type": "object", "properties": { "blue": { "type": "string" }, "green": { "type": "string" }, "red": { "type": "string" } } } } } } } }