{"openapi":"3.0.0","info":{"title":"UP42 API","contact":{"name":"Contact support","email":"support@sa.up42.com"},"license":{"name":"Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License","url":"http://creativecommons.org/licenses/by-nc-nd/4.0/"},"version":"1.2"},"servers":[{"url":"https://api.sa.up42.com"}],"security":[{"httpBearer":[]}],"tags":[{"name":"Token"},{"name":"Glossary"},{"name":"Tasking"},{"name":"Catalog"},{"name":"Orders"},{"name":"Geometries"},{"name":"Processing"},{"name":"Assets"},{"name":"STAC"},{"name":"Webhooks"},{"name":"Credits"}],"paths":{"/v2/collections":{"get":{"tags":["Glossary"],"summary":"Get geospatial collections","description":"Get a list of collections. A collection is a geospatial dataset that is available for catalog or tasking ordering.\n","operationId":"listCollectionsV2","parameters":[{"$ref":"#/components/parameters/Integrations"},{"$ref":"#/components/parameters/CollectionType"},{"$ref":"#/components/parameters/PageablePage"},{"$ref":"#/components/parameters/GlossaryV2PageableSize"},{"$ref":"#/components/parameters/GlossaryV2PageableSorting"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfCollections"}}}}},"security":[]}},"/v2/collections/{collection-name}":{"get":{"tags":["Glossary"],"summary":"Get a geospatial collection","description":"Get information about a specific collection. A collection is a geospatial dataset that is available for catalog or tasking ordering.\n","operationId":"getCollectionV2","parameters":[{"$ref":"#/components/parameters/CollectionNameInPath"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CollectionFullAggregate"}}}},"404":{"description":"Collection not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicErrorResponse"},"example":{"code":404,"message":"Collection with name $collectionName not found","details":null}}}}}}},"/v2/data-products":{"get":{"tags":["Glossary"],"summary":"Get data products","description":"Get a list of data products. A data product is a type of imagery with a specific geometric and radiometric processing level and file format.\n","operationId":"listDataProductsV2","parameters":[{"$ref":"#/components/parameters/DataProductId"},{"$ref":"#/components/parameters/PageablePage"},{"$ref":"#/components/parameters/GlossaryV2PageableSize"},{"$ref":"#/components/parameters/GlossaryV2PageableSorting"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfDataProducts"}}}}},"security":[]}},"/v2/data-products/{data-product-name}":{"get":{"tags":["Glossary"],"summary":"Get a data product","description":"Get information about a specific data product. A data product is a type of imagery with a specific geometric and radiometric processing level and file format.\n","operationId":"getDataProductV2","parameters":[{"$ref":"#/components/parameters/DataProductNameInPath"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataProductAggregate"}}}},"404":{"description":"Data product not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicErrorResponse"},"example":{"error":{"code":404,"message":"Data product with name $dataProductName not found","details":null}}}}}}}},"/v2/tasking/quotation":{"get":{"tags":["Tasking"],"summary":"Get quotations for tasking orders","description":"Get a list of all quotations for tasking orders.","operationId":"listTaskingQuotation","parameters":[{"name":"id","in":"query","description":"The quotation ID.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}},{"$ref":"#/components/parameters/WorkspaceIdQuery"},{"$ref":"#/components/parameters/OrderIdQuery"},{"name":"decision","in":"query","description":"The status of quotations.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/TaskingQuotationDecision"}}},{"$ref":"#/components/parameters/PageableSize"},{"$ref":"#/components/parameters/PageablePage"},{"$ref":"#/components/parameters/PageableSort"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskingQuotationListResponse"}}}},"401":{"$ref":"#/components/responses/OrderingUnauthorized"}},"security":[{"httpBearer":[]}]}},"/v2/tasking/quotation/{quotation-id}":{"patch":{"tags":["Tasking"],"summary":"Decide on a quotation","description":"Accept or reject a quotation for a tasking order.\n\nThis operation is only allowed on quotations with the `NOT_DECIDED` status.\n","operationId":"updateTaskingQuotation","parameters":[{"name":"quotation-id","in":"path","description":"The quotation ID.","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/TaskingQuotationPatchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskingQuotation"}}}},"401":{"$ref":"#/components/responses/OrderingUnauthorized"},"402":{"$ref":"#/components/responses/PaymentRequiredV2"},"404":{"$ref":"#/components/responses/NotFoundV2"},"405":{"description":"Quotation already decided or deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedResponseV2"}}}},"503":{"$ref":"#/components/responses/ServiceUnavailableV2"}},"security":[{"httpBearer":[]}]}},"/v2/coverage/orders/{order-id}":{"get":{"tags":["Tasking"],"summary":"Get coverage of order assets","description":"Get coverage information for a tasking order:\n  - The total covered geometry, its area, and its percentage relative to the ordered geometry\n  - The total remainder geometry, its area, and its percentage relative to the ordered geometry\n\nThis endpoint works with tasking orders that have the following [statuses](https://docs.sa.up42.com/developers/api-tasking/tasking-monitor#order-statuses), if any assets have been delivered: `BEING_FULFILLED`, `FULFILLED`, `FAILED_PERMANENTLY`.\n","operationId":"getOrderCoverage","parameters":[{"$ref":"#/components/parameters/OrderIdPath"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDeliveryMetrics"}}}},"401":{"$ref":"#/components/responses/CoverageUnauthorized"}},"security":[{"httpBearer":[]}]}},"/catalog/hosts/{host-name}/stac/search":{"post":{"tags":["Catalog"],"summary":"Search the catalog by host name","description":"Get a list of available full scenes from the catalog.\n","operationId":"searchByHost","parameters":[{"$ref":"#/components/parameters/HostNamePath"},{"name":"next","in":"query","description":"Search for previous (`prev:{ID}`) or next (`next:{ID}`) full scenes from the results page.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"next:1b4d92d4-dd58-484a-9ebb-11c668d58776"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequestDto"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StacResponse"}}}},"401":{"$ref":"#/components/responses/CatalogUnauthorized"},"404":{"$ref":"#/components/responses/ResourceNotFound"},"422":{"$ref":"#/components/responses/GeometryError"},"542":{"$ref":"#/components/responses/HostError"}}}},"/catalog/{host-name}/image/{image-id}/thumbnail":{"get":{"tags":["Catalog"],"summary":"Get a thumbnail","description":"Get a thumbnail of a full scene from the catalog. Not all data hosts provide thumbnails.\n\nThumbnails are small, low-resolution, light-weighted previews of full scenes. For some data hosts, thumbnails can be cropped and rotated compared to quicklooks.\n","operationId":"getThumbnailImage","parameters":[{"$ref":"#/components/parameters/HostNamePath"},{"$ref":"#/components/parameters/ImageIDPath"}],"responses":{"200":{"description":"OK","content":{"image/png":{"schema":{"$ref":"#/components/schemas/PreviewResource"}},"image/jpeg":{"schema":{"$ref":"#/components/schemas/PreviewResource"}}}},"401":{"$ref":"#/components/responses/CatalogUnauthorized"},"404":{"$ref":"#/components/responses/ResourceNotFound"},"542":{"$ref":"#/components/responses/HostError"}}}},"/catalog/{host-name}/image/{image-id}/quicklook":{"get":{"tags":["Catalog"],"summary":"Get a quicklook","description":"Get a quicklook of a full scene from the catalog. Not all data hosts provide quicklooks.\n\nQuicklooks are low-resolution previews of full scenes on a basemap.\n","operationId":"getQuicklookImage","parameters":[{"$ref":"#/components/parameters/HostNamePath"},{"$ref":"#/components/parameters/ImageIDPath"}],"responses":{"200":{"description":"OK","content":{"image/png":{"schema":{"$ref":"#/components/schemas/PreviewResource"}},"image/jpeg":{"schema":{"$ref":"#/components/schemas/PreviewResource"}}}},"401":{"$ref":"#/components/responses/CatalogUnauthorized"},"404":{"$ref":"#/components/responses/ResourceNotFound"},"542":{"$ref":"#/components/responses/HostError"}}}},"/v2/orders":{"get":{"tags":["Orders"],"summary":"Get orders","description":"Get a list of tasking and catalog orders.","operationId":"listOrdersV2","parameters":[{"$ref":"#/components/parameters/WorkspaceIdQuery"},{"$ref":"#/components/parameters/OrderType"},{"$ref":"#/components/parameters/OrderV2Status"},{"$ref":"#/components/parameters/OrderSubStatusQuery"},{"$ref":"#/components/parameters/OrderDisplayNameQuery"},{"$ref":"#/components/parameters/DataProductIdsQuery"},{"$ref":"#/components/parameters/OrderIdsQuery"},{"$ref":"#/components/parameters/Tags"},{"$ref":"#/components/parameters/PageableSize"},{"$ref":"#/components/parameters/PageablePage"},{"$ref":"#/components/parameters/PageableSort"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrdersV2PageResponse"}}}},"401":{"$ref":"#/components/responses/OrderingUnauthorized"}},"security":[{"httpBearer":[]}]},"post":{"tags":["Orders"],"summary":"Create an order","description":"Create a new tasking or catalog order.\n","operationId":"createV2OrderUnderWorkspace","parameters":[{"$ref":"#/components/parameters/WorkspaceIdQueryRequired"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateV2OrderRequest"}}},"required":true},"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateV2OrderResponse"}}}},"400":{"description":"Order parameters errors"},"401":{"$ref":"#/components/responses/OrderingUnauthorized"}}}},"/v2/orders/{order-id}":{"get":{"tags":["Orders"],"summary":"Get an order","description":"Get information about a specific order.\n","operationId":"getOrderV2","parameters":[{"$ref":"#/components/parameters/OrderIdPathKebab"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderV2Response"}}}},"401":{"$ref":"#/components/responses/OrderingUnauthorized"},"404":{"$ref":"#/components/responses/NotFoundV2"}},"security":[{"httpBearer":[]}]},"patch":{"tags":["Orders"],"summary":"Update an order","description":"Change details of an existing tasking or catalog order.","operationId":"patchOrder","parameters":[{"$ref":"#/components/parameters/OrderIdPathKebab"}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/OrderPatchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderV2Response"}}}},"401":{"$ref":"#/components/responses/OrderingUnauthorized"},"404":{"$ref":"#/components/responses/NotFoundV2"}},"security":[{"httpBearer":[]}]}},"/v2/orders/estimate":{"post":{"tags":["Orders"],"summary":"Estimate the cost of an order","description":"Get a cost estimation before creating a tasking or a catalog order.\n\nYou can receive an overview of the overall credit amount that will be deducted from your credit balance if you decide to proceed with the ordering.\n","operationId":"estimateV2Order","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateV2OrderRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EstimateV2OrderResponse"}}}},"400":{"$ref":"#/components/responses/SmallAoi"},"401":{"$ref":"#/components/responses/OrderingUnauthorized"},"422":{"$ref":"#/components/responses/OrderingGeometryError"}}}},"/orders/schema/{data-product-id}":{"get":{"tags":["Orders"],"summary":"Get a JSON schema of an order form","description":"Get detailed information about the parameters needed to create an order for a specific data product.\n","operationId":"getJSONSchema","parameters":[{"name":"data-product-id","in":"path","description":"The data product ID.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"application/schema+json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/TaskingDynamicFormSchema"},{"$ref":"#/components/schemas/ArchiveDynamicFormSchema"}]}}}},"400":{"$ref":"#/components/responses/InvalidProductId"},"401":{"$ref":"#/components/responses/OrderingUnauthorized"},"404":{"$ref":"#/components/responses/NotImplementedSchema"},"500":{"$ref":"#/components/responses/NonIntegratedProduct"}},"security":[{"httpBearer":[]}]}},"/v2/spatial/geometries":{"get":{"tags":["Geometries"],"summary":"Get geometries","description":"Get a list of geometries saved in the library.\n","operationId":"listGeometries","parameters":[{"$ref":"#/components/parameters/WorkspaceIdQuery"},{"$ref":"#/components/parameters/DisplayNameQuery"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagableGeometryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/WorkspaceNotFound"}},"security":[{"httpBearer":[]}]},"post":{"tags":["Geometries"],"summary":"Create a geometry","description":"Add a new geometry to the library.\n","operationId":"addGeometry","parameters":[{"$ref":"#/components/parameters/WorkspaceIdQueryRequired"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGeometryRequest"}}},"required":true},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeometryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/WorkspaceNotFound"}},"security":[{"httpBearer":[]}]}},"/v2/spatial/geometries/{geometry-id}":{"get":{"tags":["Geometries"],"summary":"Get a geometry","description":"Get information about a specific geometry saved in the library.","operationId":"getGeometry","parameters":[{"$ref":"#/components/parameters/GeometryIdPath"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeometryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/GeometryNotFound"}},"security":[{"httpBearer":[]}]},"delete":{"tags":["Geometries"],"summary":"Delete a geometry","description":"Delete a geometry from the library.","operationId":"deleteGeometry","parameters":[{"$ref":"#/components/parameters/GeometryIdPath"}],"responses":{"204":{"description":"Deleted successfully"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/GeometryNotFound"}},"security":[{"httpBearer":[]}]},"patch":{"tags":["Geometries"],"summary":"Update a geometry","description":"Update an existing geometry saved in the library.","operationId":"patchGeometry","parameters":[{"$ref":"#/components/parameters/GeometryIdPath"}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/PatchGeometryRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeometryResponse"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/GeometryNotFound"}},"security":[{"httpBearer":[]}]}},"/v2/assets/{asset-id}/download-url":{"post":{"tags":["Data management"],"summary":"Create a download URL","description":"Generate a signed URL that can be used to download an asset without authentication. The generated URL is valid for 5 minutes.","operationId":"generateDownloadUrlExternal","parameters":[{"$ref":"#/components/parameters/AssetId"}],"responses":{"201":{"description":"URL created successfully","headers":{"Location":{"description":"A temporary signed URL that can be used to download the asset without authentication.","style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/SignedDownloadURL"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadUrlResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}}}}},"/v2/assets/stac":{"get":{"tags":["Data management"],"summary":"Get the data management landing page","description":"Get the data management's landing page in the STAC format.\n","operationId":"getSASLandingPage","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPage"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP401Response"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP404Response"}}}},"500":{"description":"Server error. Please contact support"}},"security":[{"httpBearer":[]}]}},"/v2/assets/stac/collections":{"get":{"tags":["Data management"],"summary":"Get STAC collections","description":"Get a list of STAC collections in your storage.","operationId":"getSASCollections","parameters":[{"name":"limit","in":"query","description":"The number of results per page.","required":false,"style":"form","explode":true,"schema":{"title":"Limit","type":"integer","description":"The number of results per page.","default":10},"example":"3"},{"name":"page","in":"query","description":"The page number. To get the first page, set the parameter to `0`.","required":false,"style":"form","explode":true,"schema":{"title":"Page","type":"integer","description":"The page number. To get the first page, set the parameter to `0`."},"example":"0"},{"name":"bbox","in":"query","description":"Search for STAC collections that are fully contained within a bounding box in the `[min longitude,min latitude,max longitude,max latitude]` format.","required":false,"style":"form","explode":true,"schema":{"title":"Bbox","type":"string","description":"Search for STAC collections that are fully contained within a bounding box in the `[min longitude,min latitude,max longitude,max latitude]` format."},"example":"160.6,-55.95,170,-25.89"},{"name":"workspace_id","in":"query","description":"The workspace ID. Use to get STAC collections from a specific workspace. Otherwise, STAC collections from the entire account will be returned.","required":false,"style":"form","explode":true,"schema":{"title":"Workspace Id","type":"string","description":"The workspace ID. Use to get STAC collections from a specific workspace. Otherwise, STAC collections from the entire account will be returned."},"example":"a19e9ab6-afad-461f-8043-ce19cfd0985b"},{"name":"asset_ids","in":"query","description":"Asset IDs. Use to search for STAC collections from any of the provided assets. The input must be a comma-separated list.","required":false,"style":"form","explode":true,"schema":{"title":"Asset Ids","type":"string","description":"Asset IDs. Use to search for STAC collections from any of the provided assets. The input must be a comma-separated list."},"example":"bab28a1c-6979-436d-b747-8dd5510fdf77, 9c7811c4-96fd-4b11-b31f-2d2cb1a35189"},{"name":"order_ids","in":"query","description":"Order IDs. Use to search for STAC collections from any of the provided orders. The input must be a comma-separated list.","required":false,"style":"form","explode":true,"schema":{"title":"Order Ids","type":"string","description":"Order IDs. Use to search for STAC collections from any of the provided orders. The input must be a comma-separated list."},"example":"076ae2d6-bad0-4d35-9028-8e83b28c6a75,9a5e7b13-4ca2-432a-98be-b76fd8947a40"},{"name":"product_ids","in":"query","description":"Data product IDs. Use to search for STAC collections from any of the provided data products. The input must be a comma-separated list.","required":false,"style":"form","explode":true,"schema":{"title":"Product Ids","type":"string","description":"Data product IDs. Use to search for STAC collections from any of the provided data products. The input must be a comma-separated list."},"example":"fadfb6a6-6803-4db9-852e-c59f74cf8db6,1bc252ce-b084-423c-86d0-f31b9d21bb7c"},{"name":"tags","in":"query","description":"Tags. Use to search for STAC collections with any of the provided tags. A tag can consist of letters, numbers, spaces, and special characters (`.`, `-`, `_`, `/`, `:`). The input must be a comma-separated list.","required":false,"style":"form","explode":true,"schema":{"title":"Tags","type":"string","description":"Tags. Use to search for STAC collections with any of the provided tags. A tag can consist of letters, numbers, spaces, and special characters (`.`, `-`, `_`, `/`, `:`). The input must be a comma-separated list."},"example":"optical,US"},{"name":"title","in":"query","description":"The STAC collection title.","required":false,"style":"form","explode":true,"schema":{"title":"Title","type":"string","description":"The STAC collection title."},"example":"4c3fc67e_DS_PHR1A_202410081629153_FR1_PX_W084N35_1102_01333"},{"name":"sources","in":"query","description":"Sources. Use to search for STAC collections from any of the provided sources. The input must be a comma-separated list.","required":false,"style":"form","explode":true,"schema":{"title":"Sources","type":"string","description":"Sources. Use to search for STAC collections from any of the provided sources. The input must be a comma-separated list."},"example":"ARCHIVE,TASKING,PROCESSING"},{"name":"cnam","in":"query","description":"Whether to search for STAC collections that are or aren't [CNAM-transformed](https://docs.sa.up42.com/data-management/cnam).\n- `true`: Search for transformed STAC collections.\n- `false`: Search for not transformed STAC collections (non-CNAM deliveries).\n","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":true},"example":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Collections"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP401Response"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP404Response"}}}},"422":{"description":"Request error. Check the `detail` property for a specific error message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP422Response"}}}},"500":{"description":"Server error. Please contact support"}},"security":[{"httpBearer":[]}]}},"/v2/assets/stac/collections/{collection-id}":{"get":{"tags":["Data management"],"summary":"Get a STAC collection","description":"Get information about a specific STAC collection.","operationId":"getSASCollection","parameters":[{"$ref":"#/components/parameters/STACCollectionID"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/STACCollection"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP401Response"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP404Response"}}}},"422":{"description":"Request error. Check the `detail` property for a specific error message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP422Response"}}}},"500":{"description":"Server error. Please contact support"}},"security":[{"httpBearer":[]}]},"delete":{"tags":["Data management"],"summary":"Delete a STAC collection","description":"Delete an existing STAC collection.","operationId":"deleteSASCollection","parameters":[{"$ref":"#/components/parameters/STACCollectionID"}],"responses":{"204":{"description":"Successfully deleted"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP401Response"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP404Response"}}}},"500":{"description":"Server error. Please contact support"}},"security":[{"httpBearer":[]}]}},"/v2/assets/stac/collections/{collection-id}/items":{"get":{"tags":["Data management"],"summary":"Get STAC items","description":"Get a list of STAC items from a specific STAC collection in your storage.","operationId":"getSASItems","parameters":[{"$ref":"#/components/parameters/STACCollectionID"},{"name":"limit","in":"query","description":"The number of results per page.","required":false,"style":"form","explode":true,"schema":{"title":"Limit","type":"integer","description":"The number of results per page.","default":10},"example":"3"},{"name":"page","in":"query","description":"The page number. To get the first page, set the parameter to `0`.","required":false,"style":"form","explode":true,"schema":{"title":"Page","type":"integer","description":"The page number. To get the first page, set the parameter to `0`."},"example":"0"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCollection"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP401Response"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP404Response"}}}},"422":{"description":"Request error. Check the `detail` property for a specific error message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP422Response"}}}},"500":{"description":"Server error. Please contact support"}},"security":[{"httpBearer":[]}]}},"/v2/assets/stac/collections/{collection-id}/items/{item-id}":{"get":{"tags":["Data management"],"summary":"Get a STAC item","description":"Get information about a specific STAC item.","operationId":"getSASItem","parameters":[{"$ref":"#/components/parameters/STACCollectionID"},{"name":"item-id","in":"path","description":"The STAC item ID.","required":true,"style":"simple","explode":false,"schema":{"title":"Item Id","type":"string","description":"The STAC item ID.","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP401Response"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP404Response"}}}},"422":{"description":"Request error. Check the `detail` property for a specific error message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP422Response"}}}},"500":{"description":"Server error. Please contact support"}},"security":[{"httpBearer":[]}]},"patch":{"tags":["Data management"],"summary":"Update a STAC item","description":"Change the title and tags of a STAC item.","operationId":"patchSASItem","parameters":[{"$ref":"#/components/parameters/STACCollectionID"},{"name":"item-id","in":"path","description":"The STAC item ID.","required":true,"style":"simple","explode":false,"schema":{"title":"Item Id","type":"string","description":"The STAC item ID.","format":"uuid"},"example":"123e4567-e89b-12d3-a456-426614174000"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchItem"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Item"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP401Response"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP404Response"}}}},"422":{"description":"Request error. Check the `detail` property for a specific error message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP422Response"}}}},"500":{"description":"Server error. Please contact support"}},"security":[{"httpBearer":[]}]}},"/v2/assets/stac/queryables":{"get":{"tags":["Data management"],"summary":"Get data management search parameters","description":"Get queryable fields supported in data management searches.\n","operationId":"getSASQueryables","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryablesResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP401Response"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP404Response"}}}},"500":{"description":"Server error. Please contact support"}},"security":[{"httpBearer":[]}]}},"/v2/assets/stac/search":{"post":{"tags":["Data management"],"summary":"Get specific STAC items","description":"Make a detailed search request to find specific STAC items in your storage.","operationId":"postSASSearch","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCollection"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP401Response"}}}},"404":{"description":"Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP404Response"}}}},"422":{"description":"Request error. Check the `detail` property for a specific error message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTP422Response"}}}},"500":{"description":"Server error. Please contact support"}},"security":[{"httpBearer":[]}]}},"/v2/eulas":{"get":{"tags":["EULAs"],"summary":"Get EULAs","description":"Get a list of end-user license agreements (EULAs). A EULA is associated either with a data product or a processing algorithm, or with a group of data products or processing algorithms from the same provider.\n","operationId":"listEulasV2","parameters":[{"name":"term","in":"query","description":"The term for partial search filtering. The search is performed across EULAs' titles and descriptions.\n","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"$ref":"#/components/parameters/PageablePage"},{"$ref":"#/components/parameters/PageableSize"},{"$ref":"#/components/parameters/PageableSorting"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfEulas"}}}}},"security":[{"oauth2Profiles":["account"]}]}},"/v2/eulas/{eula-id}":{"get":{"tags":["EULAs"],"summary":"Get a EULA","description":"Get information about a specific end-user license agreement (EULA). A EULA is associated either with a data product or a processing algorithm, or with a group of data products or processing algorithms from the same provider.\n","operationId":"getEulaV2","parameters":[{"$ref":"#/components/parameters/EulaId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EulaResponse"}}}}},"security":[{"oauth2Profiles":["account"]}]}},"/v2/eulas/{eula-id}/documents":{"get":{"tags":["EULAs"],"summary":"Get EULA documents","description":"Get a list of digital documents associated with an end-user license agreement (EULA).\n","operationId":"listEulaDocumentsV2","parameters":[{"$ref":"#/components/parameters/EulaId"},{"$ref":"#/components/parameters/PageablePage"},{"$ref":"#/components/parameters/PageableSize"},{"$ref":"#/components/parameters/PageableSorting"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfEulaDocuments"}}}}},"security":[{"oauth2Profiles":["account"]}]}},"/v2/eulas/{eula-id}/documents/{eula-document-id}":{"get":{"tags":["EULAs"],"summary":"Get a EULA document","description":"Get information about a specific digital document associated with an end-user license agreement (EULA).\n","operationId":"getEulaDocumentV2","parameters":[{"$ref":"#/components/parameters/EulaId"},{"$ref":"#/components/parameters/EulaDocumentId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EulaDocumentResponse"}}}}},"security":[{"oauth2Profiles":["account"]}]},"patch":{"tags":["EULAs"],"summary":"Accept a EULA document","description":"Accept a specific digital document associated with an end-user license agreement (EULA).\n","operationId":"acceptEulaDocumentV2","parameters":[{"$ref":"#/components/parameters/EulaId"},{"$ref":"#/components/parameters/EulaDocumentId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EulaDocumentPatchRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EulaDocumentResponse"}}}}},"security":[{"oauth2Profiles":["account","eula.w"]}]}},"/v2/tasking/feasibility-studies":{"get":{"tags":["Tasking"],"summary":"Get feasibility studies for tasking orders","description":"Get a list of feasibility studies for tasking orders.\n","operationId":"listTaskingFeasibilityStudies","parameters":[{"name":"id","in":"query","description":"The feasibility study ID.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}},{"$ref":"#/components/parameters/WorkspaceIdQuery"},{"$ref":"#/components/parameters/OrderIdQuery"},{"name":"decision","in":"query","description":"The status of feasibility studies.\n","required":false,"style":"form","explode":true,"schema":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/FeasibilityStudyDecision"}}},{"$ref":"#/components/parameters/PageableSize"},{"$ref":"#/components/parameters/PageablePage"},{"$ref":"#/components/parameters/PageableSort"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeasibilityStudyListResponse"}}}},"401":{"$ref":"#/components/responses/OrderingUnauthorized"}},"security":[{"httpBearer":[]}]}},"/v2/tasking/feasibility-studies/{feasibility-study-id}":{"patch":{"tags":["Tasking"],"summary":"Choose a feasibility study option","description":"Accept one of the proposed feasibility study options.\n\nYou can only perform actions with feasibility studies with the `NOT_DECIDED` status.\n","operationId":"updateTaskingFeasibilityStudy","parameters":[{"name":"feasibility-study-id","in":"path","description":"The feasibility study ID.","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/FeasibilityStudyPatchRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeasibilityStudyPatchResponse"}}}},"404":{"$ref":"#/components/responses/NotFoundV2"},"405":{"description":"Feasibility study already decided or deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MethodNotAllowedResponseV2"}}}}},"security":[{"httpBearer":[]}]}},"/v2/tasking/orders/feasibility":{"post":{"tags":["Tasking"],"summary":"Check feasibility study requirements","description":"Check whether a feasibility study will be required for a tasking order with specific parameters.\n","operationId":"checkOrderFeasibility","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateV2OrderRequest"}}},"required":true},"responses":{"207":{"description":"Feasibility study requirement","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeasibilityRequirementsResponse"}}}},"400":{"$ref":"#/components/responses/SmallAoi"},"401":{"$ref":"#/components/responses/OrderingUnauthorized"},"422":{"$ref":"#/components/responses/OrderingGeometryError"}}}},"/v2/providers":{"get":{"tags":["Glossary"],"summary":"Get providers","description":"Get a list of providers. A provider is an organization that offers geospatial data by producing or hosting it.\n","operationId":"listProvidersV2","parameters":[{"$ref":"#/components/parameters/PageablePage"},{"$ref":"#/components/parameters/GlossaryV2PageableSize"},{"$ref":"#/components/parameters/GlossaryV2PageableSorting"},{"$ref":"#/components/parameters/ProviderRole"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOfProviders"}}}}},"security":[]}},"/v2/providers/{provider-name}":{"get":{"tags":["Glossary"],"summary":"Get a provider","description":"Get information about a specific provider. A provider is an organization that offers geospatial data by producing or hosting it.\n","operationId":"getProviderV2","parameters":[{"$ref":"#/components/parameters/ProviderNameInPath"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProviderWithRoles"}}}},"404":{"description":"Provider not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasicErrorResponse"},"example":{"error":{"code":404,"message":"Provider with name $providerName not found","details":null}}}}}}}},"/v2/tasking/orders/opportunities":{"post":{"tags":["Tasking"],"summary":"Get tasking order opportunities","description":"Get opportunities for a potential tasking order. An opportunity is a time interval when a sensor's pass over your AOI aligns with the specified order parameters.\n","operationId":"listV2TaskingOrderOpportunities","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateV2OrderRequest"}}},"required":true},"responses":{"207":{"description":"Opportunities successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTaskingOrderOpportunitiesV2Response"}}}},"400":{"description":"Not valid or missing order parameters"},"501":{"$ref":"#/components/responses/NotImplementedV2"}}}},"/v2/orders/{order-id}/cancellation":{"post":{"tags":["Orders"],"summary":"Cancel an order","description":"Cancel an order currently in the `CREATED` or `PLACEMENT_FAILED` status. Once canceled, the order moves to the `CANCELED` status.\n","operationId":"cancelOrder","parameters":[{"$ref":"#/components/parameters/OrderIdPathKebab"}],"responses":{"200":{"description":"Order canceled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrderResponse"}}}},"400":{"description":"Order can't be canceled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelOrderError"}}}}},"security":[{"httpBearer":[]}]}}},"components":{"schemas":{"Sort":{"type":"object","properties":{"empty":{"type":"boolean"},"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"}}},"PreviewResource":{"type":"string","format":"byte"},"Link":{"type":"object","properties":{"rel":{"type":"string","example":"self"},"href":{"type":"string","example":"https://api.up42.dev/catalog/hosts/oneatlas/stac/search"}}},"Asset":{"title":"Asset","required":["href"],"type":"object","properties":{"href":{"title":"Data URL","type":"string","description":"The URL of a downloadable or a streamable file related to the STAC asset.","example":"https://api.sa.up42.com/v2/assets/asset-id"},"title":{"title":"Data title","type":"string","description":"The STAC asset title.","nullable":true,"example":"Red band"},"description":{"title":"Data description","type":"string","description":"The STAC asset description.","nullable":true,"example":"Red band covers spectral range x to z nanometer"},"type":{"title":"Data media type","type":"string","description":"The STAC asset data type.","example":"image/tiff"},"roles":{"title":"Data role","type":"array","description":"The purpose of the STAC asset.","nullable":true,"example":["data"],"items":{"type":"string"}}}},"SearchRequestDto":{"type":"object","properties":{"collections":{"uniqueItems":true,"type":"array","description":"The names of the collections whose full scenes you want to include in search results.\n","nullable":true,"example":["pneo","phr"],"items":{"type":"string"}},"ids":{"uniqueItems":true,"type":"array","description":"The IDs of specific full scenes you want to include in search results.\n","nullable":true,"example":["f6b86de1-a9ea-4322-99fe-23126d2784b6"],"items":{"type":"string"}},"datetime":{"type":"string","description":"Search for full scenes that have a temporal property that intersects the datetime value in the RFC 3339 format. You can search for a specific date and time, or for a closed or an open date interval. Express open intervals using double-dots.\n\n- A timestamp: `2025-02-12T23:20:50Z`\n- A closed interval: `2025-02-12T00:00:00Z/2025-03-18T12:31:12Z`\n- An interval without end date: `2025-02-12T00:00:00Z/..`\n- An interval without start date: `../2025-03-18T12:31:12Z`\n","nullable":true,"example":"2025-01-01T00:00:00Z/2025-01-15T23:59:59Z"},"limit":{"maximum":500,"minimum":1,"type":"integer","description":"The number of full scenes on a results page.\n","format":"int32","nullable":true,"example":100},"query":{"$ref":"#/components/schemas/CatalogStacQuery"},"bbox":{"maxItems":4,"minItems":4,"type":"array","description":"A search geometry in the GeoJSON format. Returns images that intersect with the defined rectangle and may not fully cover it. Use only if `intersects` isn't specified.\n","nullable":true,"example":[6.553674,62.191632,6.560222,62.195116],"items":{"type":"number","format":"double"}},"intersects":{"$ref":"#/components/schemas/Polygon"}}},"Properties":{"required":["collection","constellation","id","producer","providerName","providerProperties","sceneId","up42:usageType"],"type":"object","properties":{"id":{"type":"string","description":"The full scene ID. Use for data ordering.\n","example":"5ad07b37-f6a1-4829-bc74-0fe50528b0ed"},"acquisitionDate":{"type":"string","description":"The date and time when the sensor acquired the data.\n","format":"date-time","nullable":true,"example":"2019-03-23T10:24:03.556Z","deprecated":true},"datetime":{"type":"string","description":"The date and time when the sensor acquired the data.\n","format":"date-time","nullable":true,"example":"2019-03-24T12:12:00.556Z"},"start_datetime":{"type":"string","description":"The date and time when the sensor started the acquisition process.\n","format":"date-time","nullable":true,"example":"2019-03-23T10:24:03.556Z"},"end_datetime":{"type":"string","description":"The date and time when the sensor finished the acquisition process.\n","format":"date-time","nullable":true,"example":"2019-03-25T11:11:00.556Z"},"constellation":{"type":"string","description":"The name of the sensor.\n","example":"pneo"},"collection":{"type":"string","description":"The name of the collection.\n","example":"pneo"},"providerName":{"type":"string","example":"oneatlas","deprecated":true},"cloudCoverage":{"type":"number","description":"The percentage of cloud coverage.\n","format":"double","nullable":true,"example":0},"up42:usageType":{"uniqueItems":true,"type":"array","description":"The type of usage.\n","deprecated":true,"items":{"type":"string","enum":["DATA","ANALYTICS"]}},"providerProperties":{"type":"object","additionalProperties":true,"deprecated":true},"sceneId":{"type":"string","description":"The additional full scene ID. Don't use for data ordering.\n","example":"DS_PHR1B_201903231024035_FR1_PX_E013N52_0915_02862"},"resolution":{"type":"number","description":"The spatial resolution, in meters.\n","format":"double","example":0.5},"deliveryTime":{"type":"string","description":"The unit of data delivery time.\n","example":"MINUTES","enum":["MINUTES","HOURS","DAYS"]},"producer":{"type":"string","description":"The name of the producer.\n\nData producers are companies that initially acquired and processed the source data. Data acquired by a producer can be distributed to various hosts.\n","example":"Airbus"}}},"StacResponse":{"required":["features","links","type"],"type":"object","properties":{"features":{"type":"array","description":"A list of full scenes with the defined parameters from the chosen host.\n","items":{"$ref":"#/components/schemas/CatalogFeature"}},"links":{"type":"array","description":"A list of links related to the current endpoint. Use to navigate through objects.\n","items":{"$ref":"#/components/schemas/Link"}},"type":{"type":"string","description":"The type of GeoJSON object.\n","example":"FeatureCollection","default":"FeatureCollection"}}},"PageableObject":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/Sort"},"unpaged":{"type":"boolean"},"paged":{"type":"boolean"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}}},"ArchiveDynamicFormSchema":{"type":"object","properties":{"$schema":{"type":"string","example":"https://json-schema.org/draft-07/schema"},"type":{"type":"string","example":"object"},"properties":{"type":"object","properties":{"id":{"type":"object","properties":{"title":{"type":"string","example":"Id"},"type":{"type":"string","example":"string"}}},"aoi":{"type":"object"}}},"required":{"type":"object","example":["id","aoi"]},"definitions":{"type":"object","properties":{"Polygon":{"type":"object","properties":{"title":{"type":"string","example":"Polygon"},"description":{"type":"string","example":"Polygon Model"},"type":{"type":"string","example":"object"},"properties":{"type":"object","properties":{"type":{"type":"object","properties":{"title":{"type":"string","example":"Type"},"default":{"type":"string","example":"Polygon"},"const":{"type":"string","example":"Polygon"},"type":{"type":"string","example":"string"}}},"coordinates":{"type":"object","example":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"}}}}}}},"required":{"type":"object","example":["coordinates"]}}}}},"additionalProperties":{"type":"boolean","example":false},"title":{"type":"string","example":"OneAtlasParams"}}},"TaskingDynamicFormSchema":{"type":"object","properties":{"$schema":{"type":"string","example":"https://json-schema.org/draft-07/schema"},"type":{"type":"string","example":"object"},"required":{"type":"array","example":["geometry","displayName","acquisitionStart","acquisitionEnd","acquisitionMode","incidenceAngle","polarization"],"items":{"type":"string"}},"properties":{"type":"object","properties":{"geometry":{"type":"object"},"displayName":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"}}},"extraDescription":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"}}},"acquisitionStart":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"format":{"type":"string"}}},"acquisitionEnd":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"format":{"type":"string"}}},"acquisitionMode":{"type":"object","properties":{"type":{"type":"string"},"description":{"type":"string"},"allOf":{"type":"array","items":{"type":"object","properties":{"$ref":{"type":"string"}}}}}},"incidenceAngle":{"type":"object","properties":{"description":{"type":"string"},"maximum":{"type":"integer"},"minimum":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}}},"polarization":{"type":"object","properties":{"description":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"},"allOf":{"type":"array","items":{"type":"object","properties":{"$ref":{"type":"string"}}}}}}}},"definitions":{"type":"object","properties":{"Polygon":{"type":"object","properties":{"title":{"type":"string","example":"Polygon"},"description":{"type":"string","example":"Polygon Model"},"type":{"type":"string","example":"object"},"properties":{"type":"object","properties":{"type":{"type":"object","properties":{"title":{"type":"string","example":"Type"},"default":{"type":"string","example":"Polygon"},"const":{"type":"string","example":"Polygon"},"type":{"type":"string","example":"string"}}},"coordinates":{"type":"object","example":{"type":"array","items":{"type":"array","minItems":4,"items":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"}}}}}}},"required":{"type":"object","example":["coordinates"]}}},"acquisitionMode":{"type":"object","properties":{"title":{"type":"string"},"anyOf":{"type":"array","items":{"type":"object","properties":{"const":{"type":"string"},"title":{"type":"string"}}}}}},"polarization":{"type":"object","properties":{"title":{"type":"string"},"anyOf":{"type":"array","items":{"type":"object","properties":{"const":{"type":"string"},"title":{"type":"string"}}}}}}}},"additionalProperties":{"type":"boolean","example":false}}},"UnauthorizedErrorResponse":{"type":"object","example":{"data":null,"error":{"code":401,"message":"Full authentication is required to access this resource","details":null}}},"CollectionType":{"type":"string","description":"The type of the collection.\n","example":"ARCHIVE","enum":["ARCHIVE","TASKING"]},"Page":{"required":["empty","first","last","number","numberOfElements","size","totalElements","totalPages"],"type":"object","properties":{"pageable":{"type":"object"},"last":{"type":"boolean"},"size":{"type":"integer"},"first":{"type":"boolean"},"empty":{"type":"boolean"},"number":{"type":"integer"},"numberOfElements":{"type":"integer"},"totalElements":{"type":"integer"},"totalPages":{"type":"integer"},"sort":{"type":"object"},"content":{"type":"object"}},"description":"Page response"},"OrderSubStatus":{"type":"string","description":"An [additional status](https://docs.sa.up42.com/developers/api-tasking#order-substatuses) for the tasking order.\n","nullable":true,"enum":["FEASIBILITY_WAITING_UPLOAD","FEASIBILITY_WAITING_RESPONSE","QUOTATION_WAITING_UPLOAD","QUOTATION_WAITING_RESPONSE","QUOTATION_ACCEPTED","QUOTATION_REJECTED",null]},"AssetId":{"type":"string","description":"The asset ID.","format":"uuid","example":"8fbccd60-c828-4d8c-a4ef-3c2730d9d6bc"},"WorkspaceId":{"type":"string","description":"The workspace ID.","format":"uuid","nullable":false},"AccountId":{"type":"string","description":"The account ID.","format":"uuid","nullable":false,"example":"55434287-31bc-3ad7-1a63-d61aac11ac55"},"Collection":{"required":["description","name","title","type"],"type":"object","properties":{"name":{"type":"string","description":"The name of the collection.\n","example":"vexcel-elevate-dtm-15cm"},"title":{"type":"string","description":"The title of the collection.\n","example":"Vexcel Elevate — DTM 15 cm"},"description":{"type":"string","description":"The description of the collection.\n","example":"A very high resolution 15 cm digital terrain model, acquired over areas all over the world. The collection contains data from 2019 to the present."},"type":{"$ref":"#/components/schemas/CollectionType"}},"description":"Information about the collection.\n"},"Collections":{"title":"Collections","required":["collections","context","links"],"type":"object","properties":{"links":{"title":"Links","type":"array","description":"Links associated with the resource that can be used to navigate through objects.\n","items":{"$ref":"#/components/schemas/Link"}},"collections":{"title":"Collections","type":"array","description":"A list of STAC collections in your storage.","items":{"$ref":"#/components/schemas/STACCollection"}},"context":{"title":"Context","description":"The context of the response.","allOf":[{"$ref":"#/components/schemas/Context"}]}}},"Extent":{"title":"Extent","required":["spatial","temporal"],"type":"object","properties":{"spatial":{"title":"Spatial extent","description":"Spatial characteristics.","allOf":[{"$ref":"#/components/schemas/SpatialExtent"}]},"temporal":{"title":"Temporal extent","description":"Temporal characteristics.","allOf":[{"$ref":"#/components/schemas/TemporalExtent"}]}}},"HTTP401Response":{"title":"HTTP401Response","required":["detail","status","title"],"type":"object","properties":{"title":{"title":"401 Unauthorized Error","type":"string","example":"Unauthorized"},"status":{"title":"Unauthorized Status","type":"integer","example":401},"detail":{"title":"401 Detailed Message","type":"string","example":"Couldn't validate credentials"}}},"HTTP404Response":{"title":"HTTP404Response","required":["detail","status","title"],"type":"object","properties":{"title":{"title":"404 Not Found Error","type":"string","example":"Not Found"},"status":{"title":"Not Found Status","type":"integer","example":404},"detail":{"title":"404 Detailed Message","type":"string","example":"The resource isn't available"}}},"HTTP422Response":{"title":"HTTP422Response","required":["detail","status","title"],"type":"object","properties":{"status":{"title":"Unprocessable Entity Status","type":"integer","example":422},"title":{"title":"422 Error Title","type":"string","example":"Unprocessable Entity"},"detail":{"title":"Detail","type":"array","example":[{"loc":["body","links"],"msg":"field required","type":"value_error.missing"}],"items":{"$ref":"#/components/schemas/PydanticErrorDict"}}}},"Item":{"title":"Item","required":["collection","id","links","properties","stac_extensions","stac_version"],"type":"object","properties":{"assets":{"title":"Assets","type":"object","additionalProperties":{"$ref":"#/components/schemas/Asset"},"description":"A list of STAC assets.","example":{"6072a0ee-0fff-4755-9cc7-660711de9b35":{"href":"https://api.sa.up42.com/v2/assets/6072a0ee-0fff-4755-9cc7-660711de9b35","title":"Original Delivery","roles":["data","original"],"type":"application/zip"}},"default":{}},"links":{"title":"Links","type":"array","description":"Links associated with the resource that can be used to navigate through objects.\n","items":{"$ref":"#/components/schemas/Link"}},"stac_extensions":{"title":"STAC extensions","type":"array","description":"STAC extensions activated for the resource.\n","example":["https://api.sa.up42.com/stac-extensions/up42-order/v1.0.0/schema.json"],"items":{"type":"string"}},"geometry":{"title":"Item geometry","type":"object","description":"The data item's geometry.\n","nullable":true,"example":{"coordinates":[[[-0.12723744012390625,51.50159191029297],[-0.12723744012390625,51.5003265262352],[-0.12475743729621058,51.5003265262352],[-0.12475743729621058,51.50159191029297],[-0.12723744012390625,51.50159191029297]]],"type":"Polygon"},"anyOf":[{"$ref":"#/components/schemas/Point"},{"$ref":"#/components/schemas/MultiPoint"},{"$ref":"#/components/schemas/LineString"},{"$ref":"#/components/schemas/MultiLineString"},{"$ref":"#/components/schemas/STACPolygon"},{"$ref":"#/components/schemas/MultiPolygon"},{"$ref":"#/components/schemas/NullableObject"}]},"bbox":{"title":"Bounding box","type":"array","description":"The bounding box that encloses the data item's geometry.\n","nullable":true,"example":[160.6,-55.95,170,-25.89],"anyOf":[{"maxItems":4,"minItems":4,"type":"array","items":{"type":"number"}},{"maxItems":6,"minItems":6,"type":"array","items":{"type":"number"}},{"$ref":"#/components/schemas/NullableArray"}]},"properties":{"title":"Item properties","type":"object","description":"A list of additional STAC item metadata.","example":{"gsd":2.421570738932087,"title":"NewImage123","datetime":"2022-12-23T15:08:45.900000+00:00","platform":"SPOT-6","end_datetime":"2022-12-23T15:08:45.900000+00:00","start_datetime":"2022-12-23T15:08:45.900000+00:00","constellation":"SPOT","eo:cloud_cover":0}},"type":{"title":"Type","type":"string","description":"The type of object.\n","default":"Feature","enum":["Feature"]},"stac_version":{"title":"STAC API version","type":"string","description":"The STAC API version.\n","example":"1.0.0"},"id":{"title":"Identifier","type":"string","description":"The data item ID.","format":"uuid","example":"033b4a5a-c492-4eba-915e-2000a0a84049"},"collection":{"title":"Collection","type":"string","description":"The ID of the STAC collection the data item belongs to.\n","format":"uuid","example":"033b4a5a-c492-4eba-915e-2000a0a84049"}}},"ItemCollection":{"title":"ItemCollection","required":["context","features","links"],"type":"object","properties":{"links":{"title":"Links","type":"array","description":"Links related to the current endpoint. Use to navigate through objects.\n","items":{"$ref":"#/components/schemas/Link"}},"type":{"title":"Type","type":"string","description":"The type of object.\n","default":"FeatureCollection","enum":["FeatureCollection"]},"features":{"title":"Features","type":"array","description":"Data items returned by search.\n","items":{"$ref":"#/components/schemas/Item"}},"context":{"title":"Context","description":"The context of the response.\n","allOf":[{"$ref":"#/components/schemas/Context"}]}}},"LandingPage":{"title":"LandingPage","required":["conformsTo","description","id","links","stac_extensions","stac_version"],"type":"object","properties":{"conformsTo":{"title":"STAC API standards","type":"array","description":"Links to the standards that the resource conforms to.\n","example":["http://www.opengis.net/spec/ogcapi-features-4/1.0/conf/simpletx","https://api.stacspec.org/v1.0.0-rc.1/item-search#fields","https://api.stacspec.org/v1.0.0-rc.1/item-search#filter:basic-cql","https://api.stacspec.org/v1.0.0-rc.1/collections","http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30","https://api.stacspec.org/v1.0.0-rc.1/core","http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter","https://api.stacspec.org/v1.0.0-rc.1/item-search#context","http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core","http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter","https://api.stacspec.org/v1.0.0-rc.1/item-search#filter","https://api.stacspec.org/v1.0.0-rc.1/item-search","https://api.stacspec.org/v1.0.0-rc.1/item-search#query","http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson","https://api.stacspec.org/v1.0.0-rc.1/item-search#sort","https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features","https://api.stacspec.org/v1.0.0-rc.1/item-search#filter:cql-text"],"items":{"type":"string"}},"links":{"title":"Links","type":"array","description":"Links related to the current endpoint. Use to navigate through objects.\n","items":{"$ref":"#/components/schemas/Link"}},"stac_extensions":{"title":"STAC extensions","type":"array","description":"STAC extensions activated for the resource.\n","example":["https://api.sa.up42.com/stac-extensions/up42-order/v1.0.0/schema.json"],"items":{"type":"string"}},"title":{"title":"Title","type":"string","description":"The title of the resource.\n","nullable":true,"example":"ORT_SPOT7_20190922_094920500_000"},"description":{"title":"Description","type":"string","description":"The description of the resource.\n","example":"High-resolution 1.5m SPOT images acquired daily on a global basis. The datasets are available starting from 2012."},"stac_version":{"title":"STAC API version","type":"string","description":"The STAC API version.\n","example":"1.0.0"},"type":{"title":"STAC object type","type":"string","description":"The type of resource.\n","default":"Catalog","enum":["Catalog"]},"id":{"title":"Identifier","type":"string","description":"The resource ID.","example":"033b4a5a-c492-4eba-915e-2000a0a84049"}},"description":"The landing page schema.\n","example":{"conformsTo":["https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features","https://api.stacspec.org/v1.0.0-rc.1/item-search#filter:cql-text","https://api.stacspec.org/v1.0.0-rc.1/item-search#filter:basic-cql","http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core","http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30","http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter","https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features/extensions/transaction","https://api.stacspec.org/v1.0.0-rc.1/item-search#filter","http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/features-filter","https://api.stacspec.org/v1.0.0-rc.1/item-search","http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson","http://www.opengis.net/spec/ogcapi-features-4/1.0/conf/simpletx","https://api.stacspec.org/v1.0.0-rc.1/core","https://api.stacspec.org/v1.0.0-rc.1/item-search#sort","https://api.stacspec.org/v1.0.0-rc.1/collections"],"links":[{"href":"https://api.sa.up42.com/v2/assets/stac/","rel":"self","type":"application/json"},{"href":"https://api.sa.up42.com/v2/assets/stac/","rel":"root","type":"application/json"},{"href":"https://api.sa.up42.com/v2/assets/stac/collections","rel":"data","type":"application/json"},{"href":"https://api.sa.up42.com/v2/assets/stac/search","rel":"search","type":"application/json","method":"POST"}],"stac_extensions":[],"title":"UP42 Storage","description":"UP42 Storage STAC API","stac_version":"1.0.0","id":"up42-storage","type":"Catalog"}},"LineString":{"title":"LineString","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"LineString"},"coordinates":{"title":"Coordinates","minItems":2,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":{"type":"number"}},{"maxItems":3,"minItems":3,"type":"array","items":{"type":"number"}}]}}},"description":"LineString Model"},"MultiLineString":{"title":"MultiLineString","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"MultiLineString"},"coordinates":{"title":"Coordinates","minItems":1,"type":"array","items":{"minItems":2,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":{"type":"number"}},{"maxItems":3,"minItems":3,"type":"array","items":{"type":"number"}}]}}}},"description":"MultiLineString Model"},"MultiPoint":{"title":"MultiPoint","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"MultiPoint"},"coordinates":{"title":"Coordinates","minItems":1,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":{"type":"number"}},{"maxItems":3,"minItems":3,"type":"array","items":{"type":"number"}}]}}},"description":"MultiPoint Model"},"MultiPolygon":{"title":"MultiPolygon","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"MultiPolygon"},"coordinates":{"title":"Coordinates","minItems":1,"type":"array","items":{"minItems":1,"type":"array","items":{"minItems":4,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":{"type":"number"}},{"maxItems":3,"minItems":3,"type":"array","items":{"type":"number"}}]}}}}},"description":"MultiPolygon Model"},"Point":{"title":"Point","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"Point"},"coordinates":{"title":"Coordinates","anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":{"type":"number"}},{"maxItems":3,"minItems":3,"type":"array","items":{"type":"number"}}]}},"description":"Point Model"},"Polygon":{"required":["coordinates","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. The only allowed value is `Polygon`.","example":"Polygon","enum":["Polygon"]},"coordinates":{"type":"array","description":"The coordinates.","example":[[[13.37684864751185,52.526224085531766],[13.37684864751185,52.497575021739664],[13.423387693820644,52.497575021739664],[13.423387693820644,52.526224085531766],[13.37684864751185,52.526224085531766]]],"items":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}}}},"description":"A polygon in the GeoJSON format.\n","nullable":true,"externalDocs":{"url":"http://geojson.org/geojson-spec.html#polygon"}},"Provider":{"required":["description","name","title"],"type":"object","properties":{"name":{"type":"string","description":"The name of the provider.\n","example":"vexcel-v2"},"title":{"type":"string","description":"The title of the provider.\n","example":"Vexcel"},"description":{"type":"string","description":"The description of the provider.\n","example":"Vexcel delivers geospatial data products with high accuracy, spatial resolution, and consistency. The Vexcel Data Program is the largest in the world capturing ultra-high-resolution imagery (at 7.5 to 15cm resolution) and related geospatial data in more than 30 countries, including the U.S., Canada, U.K., Western and Eastern Europe, Australia, New Zealand, and Japan."}}},"PydanticErrorDict":{"title":"PydanticErrorDict","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Loc","type":"array","items":{"anyOf":[{"type":"string"},{"type":"integer"}]}},"msg":{"title":"Msg","type":"string"},"type":{"title":"Type","type":"string"}}},"QueryablesResponse":{"title":"QueryablesResponse","required":["$id","properties"],"type":"object","properties":{"$schema":{"title":"Endpoint schema","type":"string","description":"The schema of the response.","example":"https://json-schema.org/draft/2019-09/schema","default":"https://json-schema.org/draft/2019-09/schema"},"$id":{"title":"Endpoint ID","type":"string","description":"The URL of the endpoint.","example":"https://api.sa.up42.com/v2/assets/stac/queryables"},"type":{"title":"Endpoint type","type":"string","description":"The type of resource.","example":"object","default":"object"},"title":{"title":"Endpoint title","type":"string","description":"The title of the endpoint.","example":"STAC Storage Queryables","default":"STAC Storage Queryables"},"description":{"title":"Endpoint description","type":"string","description":"The description of the endpoint.","example":"Queryable fields for data management search.","default":"Queryable fields for data management search."},"properties":{"title":"Properties","type":"object","additionalProperties":{"$ref":"#/components/schemas/QueryableResponse"},"description":"Queryable fields for catalog search.","example":{"datetime":{"title":"datetime","description":"The date and time when the sensor acquired the data.","type":"timestamp"},"account_id":{"title":"account_id","description":"The account ID.","type":"string"},"up42-system:account_id":{"title":"up42-system:account_id","description":"The account ID.","type":"string"},"workspace_id":{"title":"workspace_id","description":"The workspace ID.","type":"string"},"up42-system:workspace_id":{"title":"up42-system:workspace_id","description":"The workspace ID.","type":"string"},"asset_id":{"title":"asset_id","description":"The asset ID.","type":"string"},"up42-system:asset_id":{"title":"up42-system:asset_id","description":"The asset ID.","type":"string"},"tags":{"title":"tags","description":"STAC item tags.","type":"array"},"up42-user:tags":{"title":"up42-user:tags","description":"STAC item tags.","type":"array"},"eo:cloud_cover":{"title":"eo:cloud_cover","description":"The percentage of cloud coverage.","type":"float"},"constellation":{"title":"constellation","description":"The platform constellation that acquired the data.","type":"string"},"gsd":{"title":"gsd","description":"The ground sampling distance.","type":"float"},"collection_name":{"title":"collection_name","description":"The collection name.","type":"string"},"up42-product:collection_name":{"title":"up42-product:collection_name","description":"The collection name.","type":"string"},"order_id":{"title":"order_id","description":"The order ID.","type":"string"},"up42-order:id":{"title":"up42-order:id","description":"The order ID.","type":"string"},"source":{"title":"source","description":"The source of the STAC item.","type":"string"},"up42-system:source":{"title":"up42-system:source","description":"The source of the STAC item.","type":"string"},"data_product_id":{"title":"data_product_id","description":"The data product ID.","type":"string"},"up42-product:product_id":{"title":"up42-product:product_id","description":"The data product ID.","type":"string"},"created":{"title":"created","description":"The date and time when the STAC item was added to your storage.","type":"timestamp"},"title":{"title":"title","description":"The filename of the STAC item.","type":"string"},"user_title":{"title":"user_title","description":"A custom title of the STAC item.","type":"string"},"up42-user:title":{"title":"up42-user:title","description":"A custom title of the STAC item.","type":"string"},"job_id":{"title":"job_id","description":"The processing job ID.","type":"string"},"up42-system:job_id":{"title":"up42-system:job_id","description":"The processing job ID.","type":"string"}}}}},"SearchPayload":{"title":"SearchPayload","type":"object","not":{"required":["bbox","intersects"],"type":"object"},"properties":{"collections":{"title":"Collections","type":"array","description":"Search for STAC items in the specified STAC collections.","example":["123e4567-e89b-12d3-a456-426614174000"],"items":{"type":"string","format":"uuid4"}},"ids":{"title":"IDs","type":"array","description":"Search for specific STAC items by their IDs.","example":["123e4567-e89b-12d3-a456-426614174000"],"items":{"type":"string","format":"uuid4"}},"datetime":{"title":"Datetime","type":"string","description":"Search for data that has a temporal property that intersects the datetime value in the RFC 3339 format. You can search for a specific date and time, or for a closed or an open date interval. Express open intervals using double-dots.\n- An example of a timestamp: `\"2025-02-12T23:20:50Z\"`.\n- An example of a closed interval: `\"2025-02-12T00:00:00Z/2018-03-18T12:31:12Z\"`.\n- Examples of open intervals: `\"2025-02-12T00:00:00Z/..\"` or `\"../2025-03-18T12:31:12Z\"`.'\n","example":"2025-02-12T23:20:50Z"},"sortby":{"title":"Response sorting","type":"array","description":"A results sorting method that arranges elements in ascending or descending order based on a chosen field.","example":[{"field":"datetime","direction":"desc"}],"items":{"$ref":"#/components/schemas/ItemSortClause"}},"limit":{"title":"Response record limit","maximum":10000,"minimum":1,"type":"integer","description":"The maximum number of data items on a results page.\n","example":10,"default":10},"page":{"title":"page","type":"integer","description":"The number of the page to return. To get the first page, set the parameter to `0`.","example":0},"filter":{"title":"CQL2-json filter","type":"object","description":"A [CQL2 filter](https://docs.sa.up42.com/developers/api-stac#detailed-search) that consists of arguments (`filter.args`) and operators (`filter.op`).\n","example":{"op":"and","args":[{"op":"<=","args":[{"property":"gsd"},0.7]},{"op":"<=","args":[{"property":"eo:cloud_cover"},20]}]}},"filter-lang":{"title":"Filter language","type":"string","description":"The CQL filter that encodes the value used in `filter`. The only supported value is `cql2-json`.","default":"cql2-json","enum":["cql2-json"]},"bbox":{"title":"Intersecting bbox","maxItems":4,"minItems":4,"type":"array","description":"Search for data that intersects a bounding box in the `[min longitude, min latitude, max longitude, max latitude]` format. Use only if `intersects` isn't specified.\n","example":[13.269714059978213,52.41984626981997,13.497594907423945,52.63788503383728],"items":{"type":"number","format":"double"}},"intersects":{"title":"Intersecting geometry","description":"Search for data that intersects the provided geometry. Use only if `bbox` isn't specified.\n","example":{"coordinates":[[[-0.12723744012390625,51.50159191029297],[-0.12723744012390625,51.5003265262352],[-0.12475743729621058,51.5003265262352],[-0.12475743729621058,51.50159191029297],[-0.12723744012390625,51.50159191029297]]],"type":"Polygon"},"anyOf":[{"$ref":"#/components/schemas/Point"},{"$ref":"#/components/schemas/MultiPoint"},{"$ref":"#/components/schemas/LineString"},{"$ref":"#/components/schemas/MultiLineString"},{"$ref":"#/components/schemas/STACPolygon"},{"$ref":"#/components/schemas/MultiPolygon"}]}}},"SpatialExtent":{"title":"SpatialExtent","required":["bbox"],"type":"object","properties":{"bbox":{"title":"Bounding box","type":"array","description":"The bounding box that encloses all STAC items of the STAC collection.","example":[[160.6,-55.95,170,-25.89]],"items":{"anyOf":[{"maxItems":4,"minItems":4,"type":"array","items":{"type":"number"}},{"maxItems":6,"minItems":6,"type":"array","items":{"type":"number"}}]}}}},"TemporalExtent":{"title":"TemporalExtent","required":["interval"],"type":"object","properties":{"interval":{"title":"Datetime interval","type":"array","description":"The datetime interval that spans all STAC items of the STAC collection.","example":[["2015-06-23T00:00:00Z","2019-07-10T13:44:56Z"]],"items":{"type":"array","items":{"type":"string","nullable":true}}}}},"Auditor":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"The ID of the user who performed the action.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"type":"string","description":"A marker that indicates an action was performed automatically. The only allowed value is `system`.","enum":["system"]}]},"type":{"type":"string","description":"The type of user who performed the action.","enum":["INTERNAL","ADMIN","API_KEY","USER"]}},"description":"The ID and type of the user who performed the action.\n"},"Tag":{"maxLength":180,"minLength":1,"type":"string","description":"A tag that consists of letters, numbers, spaces, and special characters (`.`, `-`, `_`, `/`, `:`).\n","example":"project-7"},"Tags":{"maxItems":30,"type":"array","description":"A list of tags that categorize the order. A tag can consist of letters, numbers, spaces, and special characters (`.`, `-`, `_`, `/`, `:`).\n","items":{"$ref":"#/components/schemas/Tag"}},"SignedDownloadURL":{"type":"string","description":"A temporary signed URL that can be used to download an asset without authentication.","format":"uri"},"DownloadUrlResponse":{"required":["url"],"type":"object","properties":{"url":{"$ref":"#/components/schemas/SignedDownloadURL"}},"description":"A generated download URL."},"TaskingQuotationListResponse":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/TaskingQuotation"}}},"description":"A list of quotations.","allOf":[{"$ref":"#/components/schemas/PageableResponse"}]},"TaskingQuotationPatchRequest":{"type":"object","properties":{"decision":{"$ref":"#/components/schemas/TaskingQuotationDecisionFinal"}},"description":"Tasking Quotation Patch Request"},"TaskingQuotation":{"required":["createdAt","createdBy","decision","decisionAt","decisionById","decisionByType","id","updatedAt","updatedBy"],"type":"object","properties":{"id":{"type":"string","description":"The quotation ID.","format":"uuid","nullable":false},"createdAt":{"type":"string","description":"The time the quotation was created.","format":"date-time","nullable":false},"createdBy":{"$ref":"#/components/schemas/Auditor"},"updatedAt":{"type":"string","description":"The last time the quotation data was changed.","format":"date-time","nullable":false},"updatedBy":{"$ref":"#/components/schemas/Auditor"},"decision":{"$ref":"#/components/schemas/TaskingQuotationDecision"},"decisionById":{"type":"string","description":"The ID of the user that made a decision on this quotation.","format":"uuid","nullable":true},"decisionByType":{"type":"string","description":"The type of user that made a decision on this quotation.","nullable":true,"enum":["USER","ADMIN","API","SYSTEM",null]},"decisionAt":{"type":"string","description":"The time the decision was made on this quotation.","format":"date-time","nullable":true}},"description":"A response for a decided tasking quotation.","allOf":[{"$ref":"#/components/schemas/TaskingQuotationPreSave"}]},"TaskingQuotationPreSave":{"required":["accountId","creditsPrice","orderId","workspaceId"],"type":"object","properties":{"accountId":{"$ref":"#/components/schemas/AccountId"},"workspaceId":{"$ref":"#/components/schemas/WorkspaceId"},"orderId":{"$ref":"#/components/schemas/OrderId"},"creditsPrice":{"type":"integer","description":"The amount of credits that will be charged.","format":"int32","nullable":false,"example":1}},"description":"Tasking Quotation DTO before creation"},"TaskingQuotationDecision":{"type":"string","description":"The decision for this quotation.","nullable":false,"default":"NOT_DECIDED","enum":["NOT_DECIDED","ACCEPTED","REJECTED"]},"TaskingQuotationDecisionFinal":{"type":"string","description":"The decision made for this quotation.","nullable":false,"enum":["ACCEPTED","REJECTED"]},"FeasibilityStudyPatchRequest":{"type":"object","properties":{"acceptedOptionId":{"type":"string","description":"The ID of the option to accept.","format":"uuid","nullable":false}},"description":"Feasibility Study Update Request"},"FeasibilityStudyPatchResponse":{"type":"object","description":"Feasibility Study Update Response","allOf":[{"$ref":"#/components/schemas/FeasibilityStudy"}]},"FeasibilityStudyListResponse":{"required":["content"],"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/FeasibilityStudy"}}},"description":"Feasibility Study Page","allOf":[{"$ref":"#/components/schemas/PageableResponse"}]},"FeasibilityStudy":{"required":["options"],"type":"object","properties":{"options":{"minItems":0,"type":"array","description":"Options available for the feasibility study.","nullable":false,"items":{"$ref":"#/components/schemas/FeasibilityOption"}},"decisionOption":{"type":"object","description":"The option of the feasibility study that was accepted.","nullable":true,"anyOf":[{"$ref":"#/components/schemas/FeasibilityOption"},{"type":"object","nullable":true}]},"difficulty":{"$ref":"#/components/schemas/FeasibilityDifficulty"}},"description":"feasibility study DTO","allOf":[{"$ref":"#/components/schemas/FeasibilityStudyWithoutOption"}]},"FeasibilityStudyWithoutOption":{"required":["createdAt","createdBy","decision","id","updatedAt","updatedBy"],"type":"object","properties":{"id":{"type":"string","description":"The feasibility study ID.","format":"uuid","nullable":false},"createdAt":{"type":"string","description":"The time the feasibility study was created.","format":"date-time","nullable":false},"createdBy":{"$ref":"#/components/schemas/Auditor"},"updatedAt":{"type":"string","description":"The last time the feasibility study was changed.","format":"date-time","nullable":false},"updatedBy":{"$ref":"#/components/schemas/Auditor"},"decision":{"$ref":"#/components/schemas/FeasibilityStudyDecision"},"decisionById":{"type":"string","description":"The ID of the user that made a decision on this feasibility study.","format":"uuid","nullable":true},"decisionByType":{"type":"string","description":"The type of user that made a decision on this feasibility study.","nullable":true,"enum":["USER","ADMIN","API","SYSTEM",null]},"decisionAt":{"type":"string","description":"The time the decision was made on this feasibility study.","format":"date-time","nullable":true},"comment":{"type":"string","description":"Additional information related to the feasibility study. When the feasibility type is `AUTO`, a comment might be provided to give context regarding the assessment.\n","nullable":true,"example":"Only one tasking opportunity available. Might require schedule adjustment.\n"},"difficulty":{"$ref":"#/components/schemas/FeasibilityDifficulty"}},"description":"feasibility study DTO","allOf":[{"$ref":"#/components/schemas/FeasibilityStudyPreSave"}]},"FeasibilityStudyPreSave":{"required":["accountId","orderId","type","workspaceId"],"type":"object","properties":{"accountId":{"$ref":"#/components/schemas/AccountId"},"workspaceId":{"$ref":"#/components/schemas/WorkspaceId"},"orderId":{"$ref":"#/components/schemas/OrderId"},"type":{"type":"string","description":"The feasibility study type.","nullable":false,"enum":["AUTO","MANUAL"]},"difficulty":{"$ref":"#/components/schemas/FeasibilityDifficulty"}},"description":"feasibility study DTO before creation"},"FeasibilityStudyDecision":{"type":"string","description":"The decision for this feasibility study.","nullable":false,"default":"NOT_DECIDED","enum":["NOT_DECIDED","ACCEPTED"]},"FeasibilityOption":{"required":["createdAt","id","updatedAt"],"type":"object","properties":{"id":{"type":"string","description":"The feasibility study option ID.","format":"uuid","nullable":false,"example":"aa183717-1491-427b-8534-4077f0f86a62"},"createdAt":{"type":"string","description":"The time the feasibility study option was created.","format":"date-time","nullable":false,"example":"2025-12-13T11:02:44.051539Z"},"updatedAt":{"type":"string","description":"The last time the feasibility study option was changed.","format":"date-time","nullable":false,"example":"2025-12-13T11:02:44.051539Z"},"studyId":{"type":"string","description":"The feasibility study ID.","format":"uuid","nullable":false,"example":"77dece60-1964-4e7b-a318-4f0afc04a232"}},"allOf":[{"$ref":"#/components/schemas/FeasibilityOptionPreSave"}]},"FeasibilityOptionPreSave":{"required":["description","paramType"],"type":"object","properties":{"description":{"minLength":1,"type":"string","description":"A description of the feasibility study option.","nullable":false,"example":"Option 1 with 30% cloud coverage"},"paramType":{"type":"string","description":"The parameter type for this feasibility option, indicating whether the original order parameters or an alternate set of parameters were used to evaluate this option.\n","nullable":false,"example":"ORIGINAL_PARAMS","enum":["ORIGINAL_PARAMS","ALTERNATE_PARAMS"]}},"description":"Tasking feasibility study option DTO before creation"},"PageableResponse":{"required":["number","numberOfElements","size","totalElements","totalPages"],"type":"object","properties":{"pageable":{"$ref":"#/components/schemas/Page"},"last":{"type":"boolean","example":true},"totalElements":{"type":"integer","example":1},"totalPages":{"type":"integer","example":1},"sort":{"type":"object","properties":{"unsorted":{"type":"boolean","example":false},"sorted":{"type":"boolean","example":true},"empty":{"type":"boolean","example":false}}},"numberOfElements":{"type":"integer","example":1},"first":{"type":"boolean","example":true},"size":{"type":"integer","example":10},"number":{"type":"integer","example":0},"empty":{"type":"boolean","example":false}}},"MethodNotAllowedResponseV2":{"type":"object","properties":{"status":{"type":"integer","example":405},"title":{"type":"string","example":"Resource is write-protected."},"detail":{"type":"object","nullable":true}}},"OrderResponseSharedProperties":{"required":["accountId","createdAt","createdBy","id","type","updatedAt","updatedBy","workspaceId"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/OrderId"},"workspaceId":{"$ref":"#/components/schemas/WorkspaceId"},"accountId":{"$ref":"#/components/schemas/AccountId"},"type":{"$ref":"#/components/schemas/OrderType"},"dataProductId":{"type":"string","description":"The data product ID.\n","format":"uuid","nullable":true,"example":"acc3f9a4-b622-49c1-b1e1-c762aa3e7e13"},"createdAt":{"type":"string","description":"The timestamp when the order was created.\n","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp when the order was last updated.\n","format":"date-time"},"createdBy":{"$ref":"#/components/schemas/Auditor"},"updatedBy":{"$ref":"#/components/schemas/Auditor"},"tags":{"$ref":"#/components/schemas/Tags"}}},"TaskingOrderDetailsSharedProperties":{"required":["acquisitionEnd","acquisitionStart","geometry"],"type":"object","properties":{"acquisitionStart":{"$ref":"#/components/schemas/AcquisitionStart"},"acquisitionEnd":{"$ref":"#/components/schemas/AcquisitionEnd"},"geometry":{"$ref":"#/components/schemas/OrderingGeometry"},"extraDescription":{"type":"string","description":"An additional order description.\n","example":"Rail infrastructure monitoring."},"subStatus":{"$ref":"#/components/schemas/OrderSubStatus"}}},"OrderId":{"type":"string","description":"The order ID.","format":"uuid","nullable":false},"OrderType":{"type":"string","description":"The order type.","enum":["TASKING","ARCHIVE"]},"OrderV2Status":{"type":"string","description":"The [order status](https://docs.sa.up42.com/developers/api-tasking#order-statuses).\n","enum":["CREATED","BEING_PLACED","PLACED","PLACEMENT_FAILED","BEING_FULFILLED","FULFILLED","FAILED_PERMANENTLY","CANCELED"]},"OrderDisplayName":{"maxLength":200,"minLength":1,"type":"string","description":"A human-readable name that describes the order.","example":"Pléiades Neo over North America"},"OrderV2Response":{"required":["displayName"],"type":"object","properties":{"displayName":{"$ref":"#/components/schemas/OrderDisplayName"},"orderDetails":{"$ref":"#/components/schemas/OrderDetailsV2"},"status":{"$ref":"#/components/schemas/OrderV2Status"}},"allOf":[{"$ref":"#/components/schemas/OrderResponseSharedProperties"}]},"OrdersV2PageResponse":{"type":"object","properties":{"content":{"type":"array","description":"A list of orders.","items":{"$ref":"#/components/schemas/OrderV2Response"}}},"description":"Order page","allOf":[{"$ref":"#/components/schemas/PageableResponse"}]},"OrderDetailsV2":{"type":"object","oneOf":[{"$ref":"#/components/schemas/TaskingOrderDetailsV2"},{"$ref":"#/components/schemas/ArchiveOrderDetailsV2"}]},"TaskingOrderDetailsV2":{"type":"object","description":"Tasking order details.\n","allOf":[{"$ref":"#/components/schemas/TaskingOrderDetailsSharedProperties"}]},"ResolutionValue":{"required":["minimum"],"type":"object","properties":{"minimum":{"type":"number","description":"The best possible resolution available for the collection, in meters.\n","example":0.15},"maximum":{"type":"number","description":"The least detailed resolution available for the collection, in meters. The parameter is omitted if the collection has only one resolution value, specified in `minimum`.\n","nullable":true,"example":0.2}},"description":"The level of detail achievable for the collection.\n"},"ProductType":{"type":"string","description":"The type of product the collection delivers.\n","example":"ELEVATION","enum":["OPTICAL","SAR","ELEVATION"]},"CreateV2OrderRequest":{"required":["dataProduct","displayName","featureCollection","params"],"type":"object","properties":{"dataProduct":{"type":"string","description":"The data product ID.","format":"uuid","example":"07c33a51-94b9-4509-84df-e9c13ea92b84"},"displayName":{"$ref":"#/components/schemas/OrderDisplayName"},"tags":{"$ref":"#/components/schemas/Tags"},"params":{"type":"object","additionalProperties":true,"description":"Order parameters, excluding spatial geometry handled in the `featureCollection` object.\n","example":{"spectralBands":"bundle","radiometricProcessing":"reflectance","geometricProcessing":"orthorectified","pixelCoding":"16bit","priority":"high","maxIncidenceAngle":20,"maxCloudCover":20,"projection":"4326","acquisitionMode":"mono","acquisitionStart":"2025-11-20T00:00:00.000Z","acquisitionEnd":"2025-11-27T00:00:00.000Z"}},"featureCollection":{"$ref":"#/components/schemas/OrderingFeatureCollection"}}},"CreateV2OrderResponse":{"required":["errors","results"],"type":"object","properties":{"results":{"type":"array","description":"Details of the created orders. If you have defined multiple geometries, each geometry will result in a separate order.\n","items":{"$ref":"#/components/schemas/V2ResultDetails"}},"errors":{"type":"array","description":"Failed geometries error details.\n","items":{"$ref":"#/components/schemas/CreateV2OrderErrorDetails"}}},"description":"The created orders data.\n"},"V2ResultDetails":{"required":["id","index"],"type":"object","properties":{"index":{"type":"number","description":"The created order index number. Indexing starts from zero.\n"},"id":{"type":"string","description":"The created order ID.","format":"uuid"}}},"CreateV2OrderErrorDetails":{"required":["details","index","message"],"type":"object","properties":{"index":{"type":"number","description":"The failed order index number.\n"},"message":{"type":"string","description":"The error message associated with the failed order."},"details":{"type":"string","description":"Error message details."}}},"FeatureCollection":{"required":["features","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. The only allowed value is `FeatureCollection`.\n","enum":["FeatureCollection"]},"features":{"type":"array","description":"GeoJSON features.\n","items":{"$ref":"#/components/schemas/CoverageFeature"}}},"description":"A GeoJSON feature collection.\n","externalDocs":{"url":"https://tools.ietf.org/html/rfc7946#section-3.3"}},"EstimateV2OrderResponse":{"required":["errors","results","summary"],"type":"object","properties":{"summary":{"$ref":"#/components/schemas/EstimationV2Summary"},"results":{"type":"array","items":{"$ref":"#/components/schemas/EstimationV2Result"}},"errors":{"type":"array","example":[],"items":{"$ref":"#/components/schemas/BatchEndpointErrorDetail"}}},"description":"The cost estimation.\n"},"EstimationV2Summary":{"required":["totalCredits","totalSize","unit"],"type":"object","properties":{"totalCredits":{"type":"number","description":"The estimate of the order cost, in credits.\n","format":"int32","nullable":false,"example":14424,"default":0},"totalSize":{"type":"number","description":"The size of the order in square kilometers or the number of scenes needed to cover the requested geometry.","nullable":false,"example":8.48,"default":0},"unit":{"$ref":"#/components/schemas/EstimateV2OrderPricingUnit"}},"description":"The overview of the estimation.\n"},"EstimationV2Result":{"required":["credits","index","size","unit"],"type":"object","properties":{"index":{"type":"number","description":"The geometry index number. Indexing starts from zero.\n","format":"int32"},"credits":{"type":"number","description":"The estimated cost of the geometry, in credits.\n","format":"int32","example":14424},"size":{"type":"number","description":"The size of the geometry.","example":8.48},"unit":{"$ref":"#/components/schemas/EstimateV2OrderPricingUnit"}},"description":"Results for each of the specified geometries.\n"},"EstimateV2OrderPricingUnit":{"type":"string","description":"The unit of measurement used to calculate the size.\n","nullable":true,"enum":["SQ_KM","SCENE",null]},"OrderingFeature":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. The only allowed value is `Feature`.\n","enum":["Feature"]},"geometry":{"$ref":"#/components/schemas/OrderingGeometry"},"properties":{"type":"object"}},"description":"A spatially bounded GeoJSON feature.\n","externalDocs":{"url":"https://tools.ietf.org/html/rfc7946#section-3.2"}},"GeometryResponse":{"required":["accountId","createdAt","displayName","featureCollection","id","updatedAt","workspaceId"],"type":"object","properties":{"id":{"type":"string","description":"The geometry ID.","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"displayName":{"maxLength":200,"minLength":1,"type":"string","description":"The name of the geometry.","example":"Berlin Tiergarten"},"featureCollection":{"$ref":"#/components/schemas/FeatureCollection"},"accountId":{"type":"string","description":"The account ID.","format":"uuid","example":"ca4f7511-d3b9-4cde-b1fa-05d9d16e7b57"},"workspaceId":{"type":"string","description":"The workspace ID.","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"},"createdAt":{"type":"string","description":"The timestamp when the geometry was created.\n","format":"date-time"},"updatedAt":{"type":"string","description":"The timestamp when the geometry was last updated.\n","format":"date-time"}}},"PagableGeometryResponse":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/GeometryResponse"}},"totalPages":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"sort":{"$ref":"#/components/schemas/Sort"},"first":{"type":"boolean"},"last":{"type":"boolean"},"numberOfElements":{"type":"integer","format":"int32"},"pageable":{"$ref":"#/components/schemas/PageableObject"},"size":{"type":"integer","format":"int32"},"number":{"type":"integer","format":"int32"},"empty":{"type":"boolean"}}},"CreateGeometryRequest":{"required":["displayName","featureCollection"],"type":"object","properties":{"displayName":{"maxLength":200,"minLength":1,"type":"string","description":"The name of the geometry.","example":"Berlin Tiergarten"},"featureCollection":{"$ref":"#/components/schemas/FeatureCollection"}}},"PatchGeometryRequest":{"type":"object","properties":{"displayName":{"maxLength":200,"minLength":1,"type":"string","description":"The name of the geometry.","example":"Berlin Tiergarten"},"featureCollection":{"$ref":"#/components/schemas/FeatureCollection"}}},"CatalogFeature":{"required":["geometry","properties","type"],"type":"object","properties":{"geometry":{"$ref":"#/components/schemas/CatalogGeometry"},"properties":{"$ref":"#/components/schemas/Properties"},"bbox":{"type":"array","example":[6.553674,62.191632,6.560222,62.195116],"items":{"type":"number"}},"type":{"type":"string","default":"Feature"}},"description":"A list of full scenes with the defined parameters from the chosen host.\n"},"AreaCoverageMetrics":{"required":["covered","remainder"],"type":"object","properties":{"covered":{"description":"Information about the ordered geometry covered by assets.\n","allOf":[{"$ref":"#/components/schemas/GeometryMetrics"}]},"remainder":{"description":"Information about the ordered geometry not yet covered by assets.\n","allOf":[{"$ref":"#/components/schemas/GeometryMetrics"}]}}},"OrderDeliveryMetrics":{"type":"object","allOf":[{"$ref":"#/components/schemas/AreaCoverageMetrics"}]},"GeometryMetrics":{"required":["geometry","percentage","sqKmArea"],"type":"object","properties":{"sqKmArea":{"type":"number","description":"The area of the geometry, in km<sup>2</sup>.","example":78.5},"percentage":{"type":"number","description":"The percentage of the geometry relative to the requested geometry.\n","example":50},"geometry":{"type":"object","description":"The geometry in the GeoJSON format.","allOf":[{"$ref":"#/components/schemas/FeatureCollection"}]}}},"CoverageFeature":{"required":["geometry","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. The only allowed value is `Feature`.\n","enum":["Feature"]},"geometry":{"$ref":"#/components/schemas/CoverageGeometry"},"properties":{"type":"object","description":"Properties of the geometry.\n"}},"description":"A spatially bounded GeoJSON feature.\n","externalDocs":{"url":"https://tools.ietf.org/html/rfc7946#section-3.2"}},"OrderingFeatureCollection":{"required":["features","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of GeoJSON object. The only allowed value is `FeatureCollection`.\n","enum":["FeatureCollection"]},"features":{"type":"array","description":"GeoJSON features.\n","items":{"$ref":"#/components/schemas/OrderingFeature"}}},"description":"A GeoJSON feature collection.\n","externalDocs":{"url":"https://tools.ietf.org/html/rfc7946#section-3.3"}},"ArchiveOrderDetailsSharedProperties":{"required":["aoi"],"type":"object","properties":{"aoi":{"$ref":"#/components/schemas/OrderingGeometry"},"imageId":{"type":"string","description":"The ID of the image scene.\n","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}}},"ArchiveOrderDetailsV2":{"type":"object","description":"Catalog order details.\n","allOf":[{"$ref":"#/components/schemas/ArchiveOrderDetailsSharedProperties"}]},"CatalogStacQuery":{"type":"object","properties":{"cloudCoverage":{"maxProperties":1,"minProperties":1,"type":"object","properties":{"GT":{"type":"integer","description":"Greater than"},"GTE":{"type":"integer","description":"Greater than or equal to"},"LT":{"type":"integer","description":"Less than"},"LTE":{"type":"integer","description":"Less than or equal to"}},"additionalProperties":false,"description":"Search by the percentage of cloud coverage. The format is `<operator>: <integer>`. Replace `<operator>` with a comparison operator:\n\n- `GT`: greater than\n- `GTE`: greater than or equal to\n- `LT`: less than\n- `LTE`: less than or equal to\n","example":{"LT":10}}},"description":"A STAC query object.\n","nullable":true},"Context":{"title":"Context","type":"object","properties":{"limit":{"title":"Response record limit","type":"integer","description":"The maximum number of data items on a results page.\n","example":10},"returned":{"title":"Response returned items","type":"integer","description":"The number of data items returned on the results page.\n","example":5},"matched":{"title":"matched","type":"integer","description":"The total number of data items that match the search query.\n","example":20},"page":{"title":"page","type":"integer","description":"The current page number of the response.\n","example":0},"pages":{"title":"pages","type":"integer","description":"The total number of pages in the response.\n","example":10}}},"STACPolygon":{"title":"Polygon","required":["coordinates"],"type":"object","properties":{"type":{"title":"Type","type":"string","default":"Polygon"},"coordinates":{"title":"Coordinates","minItems":1,"type":"array","items":{"minItems":4,"type":"array","items":{"anyOf":[{"maxItems":2,"minItems":2,"type":"array","items":{"type":"number"}},{"maxItems":3,"minItems":3,"type":"array","items":{"type":"number"}}]}}}},"description":"Polygon Model"},"OrderPatchRequest":{"type":"object","properties":{"tags":{"maxItems":30,"type":"array","description":"A list of tags to replace tags already assigned to the order. A tag can consist of letters, numbers, spaces, and special characters (`.`, `-`, `_`, `/`, `:`).\n","items":{"$ref":"#/components/schemas/Tag"}}}},"AcquisitionStart":{"type":"string","description":"The date and time when the sensor started the acquisition process.\n","format":"date-time","nullable":false,"example":"2024-05-23T00:00:00Z"},"AcquisitionEnd":{"type":"string","description":"The date and time when the sensor finished the acquisition process.\n","format":"date-time","nullable":false,"example":"2024-06-30T00:00:00Z"},"BatchEndpointErrorDetail":{"required":["details","index","message"],"type":"object","properties":{"index":{"type":"number","description":"The failed geometry index number.\n"},"message":{"type":"string","description":"The error message associated with the failed geometry."},"details":{"type":"string","description":"Error message details."}},"description":"Errors with the operation.\n"},"EulaTitle":{"type":"string","description":"The title of the EULA.\n","example":"EULA_Airbus_Pleiades_Neo_v2"},"EulaDescription":{"type":"string","description":"The description of the EULA.\n","example":"End-user license agreement (commercial) for Airbus Pléiades Neo."},"EulaDocumentUrl":{"type":"string","description":"The URL of the EULA document.\n","format":"uri","nullable":true,"example":"https://example.com/collection-eula-2.pdf"},"EulaDocumentCurrentId":{"type":"string","description":"The ID of the active document currently associated with the EULA.\n","format":"uuid","nullable":true,"example":"a0d443a2-41e8-4995-8b54-a5cc4c448227"},"EulaDocumentFilename":{"type":"string","description":"The name of the EULA document. It is generated based on the title and version of the EULA.\n","nullable":true,"example":"collection-eula-v2.pdf"},"EulaDocumentSize":{"type":"number","description":"The size of the EULA document, in bytes.\n","format":"int64"},"EulaDocumentVersion":{"type":"number","description":"The version of the EULA document. It is automatically generated based on the count of documents associated with the EULA.\n","example":2},"EulaDocumentIsCurrent":{"type":"boolean","description":"Whether this document is the active document currently associated with the EULA.\n","example":true},"EulaDocumentValidFrom":{"type":"string","description":"The timestamp indicating the start date of the EULA document's validity.\n","format":"date-time","nullable":true,"example":"2022-12-07T09:19:27.552944Z"},"EulaDocumentisAccepted":{"type":"boolean","description":"Whether the EULA document is accepted.\n"},"EulaAcceptanceAcceptedAt":{"type":"string","description":"The timestamp indicating the date the EULA document was accepted.\n","format":"date-time","nullable":true,"example":"2022-12-07T09:19:27.552944Z"},"EulaDocumentCreatedAt":{"type":"string","description":"The timestamp indicating the date the EULA document was created.\n","format":"date-time","nullable":true,"example":"2022-12-07T09:19:27.552944Z"},"EulaAcceptanceAcceptedById":{"type":"string","description":"The ID of the user who accepted the EULA document.\n","format":"uuid","nullable":true,"example":"55434287-31bc-3ad7-1a63-d61aac11ac55"},"EulaId":{"type":"string","description":"The EULA ID.\n","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"},"EulaDocumentId":{"type":"string","description":"The EULA document ID.\n","format":"uuid","example":"a0d443a2-41e8-4995-8b54-a5cc4c448227"},"EulaDocumentPatchRequest":{"type":"object","properties":{"isAccepted":{"$ref":"#/components/schemas/EulaDocumentisAccepted"}}},"EulaResponse":{"required":["description","id","isAccepted","title"],"properties":{"id":{"$ref":"#/components/schemas/EulaId"},"currentDocumentId":{"$ref":"#/components/schemas/EulaDocumentCurrentId"},"currentDocumentValidFrom":{"$ref":"#/components/schemas/EulaDocumentValidFrom"},"currentDocumentUrl":{"$ref":"#/components/schemas/EulaDocumentUrl"},"currentDocumentCreatedAt":{"$ref":"#/components/schemas/EulaDocumentCreatedAt"},"currentDocumentFilename":{"$ref":"#/components/schemas/EulaDocumentFilename"},"title":{"$ref":"#/components/schemas/EulaTitle"},"description":{"$ref":"#/components/schemas/EulaDescription"},"isAccepted":{"$ref":"#/components/schemas/EulaDocumentisAccepted"},"acceptedAt":{"$ref":"#/components/schemas/EulaAcceptanceAcceptedAt"},"acceptedById":{"$ref":"#/components/schemas/EulaAcceptanceAcceptedById"}},"description":"A single EULA.\n"},"EulaDocumentResponse":{"required":["filename","id","isAccepted","isCurrent","size","url","version"],"properties":{"id":{"$ref":"#/components/schemas/EulaDocumentId"},"url":{"$ref":"#/components/schemas/EulaDocumentUrl"},"filename":{"$ref":"#/components/schemas/EulaDocumentFilename"},"size":{"$ref":"#/components/schemas/EulaDocumentSize"},"version":{"$ref":"#/components/schemas/EulaDocumentVersion"},"isCurrent":{"$ref":"#/components/schemas/EulaDocumentIsCurrent"},"validFrom":{"$ref":"#/components/schemas/EulaDocumentValidFrom"},"isAccepted":{"$ref":"#/components/schemas/EulaDocumentisAccepted"},"acceptedAt":{"$ref":"#/components/schemas/EulaAcceptanceAcceptedAt"},"acceptedById":{"$ref":"#/components/schemas/EulaAcceptanceAcceptedById"}},"description":"A single EULA document.\n"},"PageOfEulas":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/EulaResponse"}}},"description":"A list of EULAs.\n","allOf":[{"$ref":"#/components/schemas/Page"}]},"PageOfEulaDocuments":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/EulaDocumentResponse"}}},"description":"A list of EULA documents.\n","allOf":[{"$ref":"#/components/schemas/Page"}]},"ProviderWithRoles":{"allOf":[{"$ref":"#/components/schemas/ProviderRolesArray"},{"$ref":"#/components/schemas/Provider"}]},"ProviderRolesArray":{"required":["roles"],"type":"object","properties":{"roles":{"type":"array","description":"Provider roles:\n  - `PRODUCER`: a producer is a provider that initially acquired and processed the source data. Data acquired by a producer can be distributed to various hosts.\n  - `HOST`: a host is a provider that offers access to data acquired by a producer.\n","example":["HOST","PRODUCER"],"items":{"$ref":"#/components/schemas/ProviderRole"}}}},"ProviderRole":{"type":"string","enum":["PRODUCER","HOST"]},"CollectionExtended":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"$ref":"#/components/schemas/CollectionInfoExtension"}]},"CollectionInfoExtension":{"required":["integrations"],"type":"object","properties":{"metadata":{"$ref":"#/components/schemas/CollectionMetadata"},"integrations":{"$ref":"#/components/schemas/CollectionIntegrationArray"}}},"CollectionIntegrationArray":{"type":"array","description":"[Integration values](https://docs.sa.up42.com/developers/api-glossary#integrations) that indicate mandatory ordering steps, available actions, and mandatory or optional operations for a given collection.\n","example":["SAMPLE_DATA_AVAILABLE","QUICKLOOK_AVAILABLE","SEARCH_AVAILABLE","PRICE_ESTIMATION_AVAILABLE","THUMBNAIL_AVAILABLE"],"items":{"$ref":"#/components/schemas/CollectionIntegration"}},"CollectionIntegration":{"type":"string","enum":["ACCESS_APPROVAL_REQUIRED","SAMPLE_DATA_AVAILABLE","MANUAL_REQUEST_REQUIRED","FEASIBILITY_STUDY_REQUIRED","FEASIBILITY_STUDY_MAY_BE_REQUIRED","QUOTATION_REQUIRED","PRICE_ESTIMATION_AVAILABLE","SEARCH_AVAILABLE","THUMBNAIL_AVAILABLE","QUICKLOOK_AVAILABLE","TASKING_OPPORTUNITIES_AVAILABLE"]},"CollectionMetadata":{"type":"object","properties":{"productType":{"$ref":"#/components/schemas/ProductType"},"resolutionClass":{"$ref":"#/components/schemas/ResolutionClass"},"resolutionValue":{"$ref":"#/components/schemas/ResolutionValue"},"priority":{"$ref":"#/components/schemas/PriorityArray"},"acquisitionMode":{"$ref":"#/components/schemas/AcquisitionModeArray"}},"description":"The collection metadata."},"ResolutionClass":{"type":"string","description":"The spatial resolution class.\n","example":"VERY_HIGH","enum":["VERY_HIGH","HIGH","MEDIUM","LOW"]},"DataProduct":{"required":["description","name","title"],"type":"object","properties":{"id":{"type":"string","description":"The data product ID.\n","format":"uuid","example":"d28f2b14-b8c2-4b3c-b184-11334933eeb2"},"name":{"type":"string","description":"The data product name.\n","example":"vexcel-elevate-dtm-15cm"},"title":{"type":"string","description":"The title of the data product.\n","example":"Vexcel Elevate — DTM 15 cm"},"description":{"type":"string","description":"The description of the data product.\n","example":"A digital terrain model with a resolution of 15–20 cm."},"eulaId":{"type":"string","description":"The EULA ID.\n","format":"uuid","example":"f79efe14-bc8d-4892-bd9d-7565cb3620a5"}}},"PageOfCollections":{"allOf":[{"$ref":"#/components/schemas/Page"},{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/CollectionFullAggregate"}}}}]},"CollectionFullAggregate":{"type":"object","allOf":[{"$ref":"#/components/schemas/CollectionExtended"},{"type":"object","properties":{"providers":{"type":"array","items":{"$ref":"#/components/schemas/ProviderWithRoles"}}}},{"type":"object","properties":{"dataProducts":{"type":"array","items":{"$ref":"#/components/schemas/DataProduct"}}}}]},"CollectionAggregatedWithProviders":{"allOf":[{"$ref":"#/components/schemas/CollectionExtended"},{"required":["providers"],"type":"object","properties":{"providers":{"type":"array","items":{"$ref":"#/components/schemas/ProviderWithRoles"}}}}]},"PageOfDataProducts":{"allOf":[{"$ref":"#/components/schemas/Page"},{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/DataProductAggregate"}}}}]},"DataProductAggregate":{"type":"object","allOf":[{"$ref":"#/components/schemas/DataProduct"},{"type":"object","properties":{"collection":{"$ref":"#/components/schemas/CollectionAggregatedWithProviders"}}}]},"BasicErrorResponse":{"required":["detail","status","title"],"type":"object","properties":{"detail":{"title":"Detail","type":"string"},"status":{"title":"Status","type":"string"},"title":{"title":"Title","type":"string"}}},"STACCollection":{"title":"Collection","required":["description","extent","id","license","links","stac_extensions","stac_version"],"type":"object","properties":{"assets":{"title":"Assets","type":"object","additionalProperties":{"$ref":"#/components/schemas/Asset"},"description":"Geospatial assets.\n","example":{"6072a0ee-0fff-4755-9cc7-660711de9b35":{"href":"https://api.sa.up42.com/v2/assets/6072a0ee-0fff-4755-9cc7-660711de9b35","title":"Original Delivery","roles":["data","original"],"type":"application/zip"}},"default":{}},"links":{"title":"Links","type":"array","description":"Links related to the item. Use to navigate through objects.\n","items":{"$ref":"#/components/schemas/Link"}},"stac_extensions":{"title":"STAC extensions","type":"array","description":"STAC extensions activated for the resource.\n","example":["https://api.sa.up42.com/stac-extensions/up42-order/v1.0.0/schema.json"],"items":{"type":"string"}},"title":{"title":"Title","type":"string","description":"The title of the resource.\n","nullable":true,"example":"ORT_SPOT7_20190922_094920500_000"},"description":{"title":"Description","type":"string","description":"The description of the resource.\n","example":"High-resolution 1.5m SPOT images acquired daily on a global basis. The datasets are available starting from 2012."},"keywords":{"title":"Keywords","type":"array","description":"The keywords for the STAC collection.","example":["berlin","optical"],"items":{"type":"string"}},"license":{"title":"License","type":"string","description":"The STAC collection data license type.","example":"proprietary"},"providers":{"title":"Providers","type":"array","description":"A list of providers associated with the STAC collection.","items":{"$ref":"#/components/schemas/STACProvider"}},"extent":{"title":"Collection extent","description":"The spatiotemporal extent of the STAC collection.","example":{"spatial":{"bbox":[[-86.07022916666666,11.900145833333333,-86.05072916666667,11.942270833333334]]},"temporal":{"interval":[["2017-01-01T00:00:00Z","2021-12-31T00:00:00Z"]]}},"allOf":[{"$ref":"#/components/schemas/Extent"}]},"stac_version":{"title":"STAC API version","type":"string","description":"The UP42 STAC API version.","example":"1.0.0"},"type":{"title":"STAC object type","type":"string","description":"The type of resource.\n","default":"Collection","enum":["Collection"]},"id":{"title":"Identifier","type":"string","description":"The resource ID.","format":"uuid","example":"033b4a5a-c492-4eba-915e-2000a0a84049"}}},"STACProvider":{"title":"Provider","required":["name"],"type":"object","properties":{"name":{"title":"Provider name","type":"string","description":"The name of the provider.","example":"Airbus"},"roles":{"title":"Provider role","type":"array","description":"The role of the provider.","nullable":true,"example":["producer"],"items":{"type":"string"}},"url":{"title":"Provider website","type":"string","description":"The link to the provider's website.","nullable":true,"example":"https://www.airbus.com"}}},"QueryableResponse":{"title":"QueryableResponse","required":["description","title","type"],"type":"object","properties":{"title":{"title":"The title of the queryable field.","type":"string","example":"gsd"},"description":{"title":"The description of the queryable field.","type":"string","example":"The ground sampling distance."},"type":{"title":"The data type of the queryable field.","type":"string","example":"float"}}},"NullableObject":{"type":"object","nullable":true},"NullableArray":{"type":"array","nullable":true},"PatchItem":{"type":"object","properties":{"up42-user:title":{"maxLength":250,"minLength":1,"type":"string","description":"An updated STAC item title.","nullable":true,"example":"SPOT 6/7 NY Central Park"},"up42-user:tags":{"type":"array","description":"A list of tags that categorize the STAC item. A tag can consist of letters, numbers, spaces, and special characters (`.`, `-`, `_`, `/`, `:`).","example":["optical","US"],"items":{"maxLength":180,"minLength":1,"type":"string"}}}},"ItemSortClause":{"title":"SortUnit","required":["field"],"type":"object","properties":{"field":{"title":"Field","type":"string","description":"A field to use for sorting.","example":"eo:cloud_cover","enum":["asset_id","collection","collection_name","constellation","created","data_product_id","datetime","eo:cloud_cover","gsd","id","job_id","order_id","source","tags","title","workspace_id"]},"direction":{"title":"Direction","type":"string","description":"An order of sorting.","example":"desc","default":"asc","enum":["asc","desc"]}}},"PriorityArray":{"type":"array","description":"[Priority tiers](https://docs.sa.up42.com/data/reference/priority) available for a tasking collection.\n","example":["STANDARD"],"items":{"$ref":"#/components/schemas/Priority"}},"Priority":{"type":"string","enum":["STANDARD","HIGH","RUSH"]},"AcquisitionModeArray":{"type":"array","description":"[Acquisition modes](https://docs.sa.up42.com/data/reference/acquisition-modes) available for a collection.\n","example":["MONO"],"items":{"$ref":"#/components/schemas/AcquisitionMode"}},"AcquisitionMode":{"type":"string","enum":["MONO","STEREO","TRISTEREO","SPOT","SPOT_FINE","SPOT_EXTENDED","SPOT_ENHANCED","SPOT_ULTRA","SPOT_HIGH_RES","SPOT_HIGH_RES_300","SITE","STRIP","STRIP_ENHANCED","SCAN","SCAN_WIDE","SCAN_ENHANCED","STEREO_BURST","STEREO_AREA_COVERAGE","STEREO_SINGLE_PASS","STEREO_MULTI_PASS"]},"CatalogGeometry":{"required":["coordinates","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Only AOIs are supported.","example":"Polygon","enum":["Polygon"]},"coordinates":{"type":"array","description":"The coordinates.","example":[[[77.259584,28.622331],[77.287879,28.622632],[77.287621,28.594794],[77.259389,28.594983],[77.259584,28.622331]]],"items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"description":"The geometry in the GeoJSON format.\n","externalDocs":{"url":"http://geojson.org/geojson-spec.html#geometry-objects"}},"CoverageGeometry":{"required":["coordinates","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of geometry. Only AOIs are supported.","example":"Polygon","enum":["Polygon"]},"coordinates":{"type":"array","description":"The coordinates.","example":[[[77.259584,28.622331],[77.287879,28.622632],[77.287621,28.594794],[77.259389,28.594983],[77.259584,28.622331]]],"items":{"type":"array","items":{"type":"array","items":{"type":"number"}}}}},"description":"The geometry in the GeoJSON format.\n","externalDocs":{"url":"http://geojson.org/geojson-spec.html#geometry-objects"}},"OrderingGeometry":{"required":["coordinates","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of geometry.","example":"Polygon","enum":["Polygon","Point"]},"coordinates":{"description":"The coordinates.","example":[[[77.259584,28.622331],[77.287879,28.622632],[77.287621,28.594794],[77.259389,28.594983],[77.259584,28.622331]]],"oneOf":[{"type":"array","items":{"type":"array","items":{"minItems":2,"type":"array","items":{"type":"number","format":"double"}}}},{"type":"array","items":{"type":"number","format":"double"}}]},"crs":{"type":"object","properties":{"type":{"type":"string","description":"The parameter defining the CRS.","example":"name"},"properties":{"type":"object","properties":{"name":{"type":"string","description":"The name of the CRS.","example":"EPSG:4326"}}}},"description":"The CRS of the order."}},"description":"The geometry in the GeoJSON format.\n","externalDocs":{"url":"http://geojson.org/geojson-spec.html#geometry-objects"}},"FeasibilityRequirementsResponse":{"required":["errors","results"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/FeasibilityRequirementsResult"}},"errors":{"type":"array","example":[],"items":{"$ref":"#/components/schemas/BatchEndpointErrorDetail"}}},"description":"The feasibility requirements for the specified order parameters.\n"},"FeasibilityRequirementsResult":{"required":["difficulty","feasibilityStudyRequired","index"],"type":"object","properties":{"index":{"type":"number","description":"The geometry index number. Indexing starts from zero.\n","format":"int32","example":0},"feasibilityStudyRequired":{"type":"boolean","description":"Whether a feasibility study will be required for this geometry.\n","example":false},"difficulty":{"$ref":"#/components/schemas/FeasibilityDifficulty"}},"description":"Results for each of the specified geometries.\n"},"PageOfProviders":{"allOf":[{"$ref":"#/components/schemas/Page"},{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/ProviderWithRoles"}}}}]},"ListTaskingOrderOpportunitiesV2Response":{"required":["errors","results"],"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"index":{"type":"number","description":"The geometry index number. Indexing starts from zero.\n","format":"int32","example":0},"opportunities":{"type":"object","properties":{"features":{"type":"array","description":"GeoJSON features.\n","items":{"$ref":"#/components/schemas/OpportunitiesV2ResponseFeature"}},"status":{"type":"string","description":"The status of the tasking opportunities search.","example":"Done"},"type":{"type":"string","description":"The type of GeoJSON object. The only allowed value is `FeatureCollection`.\n","enum":["FeatureCollection"]}}}},"description":"Results for each of the specified geometries.\n"}},"errors":{"type":"array","example":[],"items":{"$ref":"#/components/schemas/BatchEndpointErrorDetail"}}},"description":"The cost estimation.\n"},"CancelOrderResponse":{"required":["orderId","status"],"type":"object","properties":{"orderId":{"$ref":"#/components/schemas/OrderId"},"status":{"type":"string","example":"CANCELED"}}},"CancelOrderError":{"required":["detail","status","title"],"type":"object","properties":{"title":{"type":"string","example":"Order with id 68567134-27ad-7bd7-4b65-d61adb11fc78 cannot be canceled in its current status."},"status":{"type":"integer","example":400},"detail":{"type":"string","example":"Cancellation allowed only in CREATED or PLACEMENT_FAILED status."}}},"OpportunitiesV2ResponseFeature":{"type":"object","properties":{"type":{"type":"string","description":"The type of GeoJSON object. The only allowed value is `Feature`.\n","enum":["Feature"]},"geometry":{"allOf":[{"type":"object","description":"The geometry of the tasking opportunity."},{"$ref":"#/components/schemas/OrderingGeometry"}]},"properties":{"type":"object","additionalProperties":true,"description":"The metadata properties of the tasking opportunity.","example":{"collectionName":"PNEO-tasking","start_datetime":"2025-05-31T11:10:44.099Z","end_datetime":"2025-05-31T11:10:45.552Z","view:incidence_angle":26.3,"view:off_nadir":63.7}},"id":{"type":"string","description":"The ID of the tasking opportunity.","example":"PNEO1"}},"description":"A tasking opportunity."},"DataProductId":{"type":"string","description":"The data product ID.","format":"uuid","nullable":true,"example":"bcc3d9a3-a632-19c2-c1e1-f762cc3c7a12"},"FeasibilityDifficulty":{"type":"string","description":"The acquisition difficulty determined by order parameters.\n","nullable":true,"example":"LOW","enum":["LOW","HIGH",null]}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","example":401},"message":{"type":"string","example":"An error occurred while attempting to decode the Jwt: Jwt expired at 2023-02-15T11:29:44Z\n"},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"SmallAoi":{"description":"Errors in order parameters","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","example":400},"message":{"type":"string","example":"AOI area must be more than 0.1 km²."},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"InvalidProductId":{"description":"Not valid data product ID","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","example":400},"message":{"type":"string","example":"Invalid data product requested"},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"GeometryError":{"description":"Request not valid","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","example":422},"message":{"type":"string","example":"1 validation error for Request\nbody -> intersects -> coordinates\nGeometry should not have more than 999 vertices. (type=value_error)\n"},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"NotFoundV2":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":404},"title":{"type":"string","example":"Resource does not exist."},"detail":{"type":"object","nullable":true}}}}}},"PaymentRequiredV2":{"description":"Not enough credits","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":402},"title":{"type":"string","example":"Not enough available credits in the account. Expected credits..."},"detail":{"type":"object","nullable":true}}}}}},"ServiceUnavailableV2":{"description":"Service unavailable, please try again later","headers":{"Retry-After":{"$ref":"#/components/headers/ResponseHeaderRetryAfter"}},"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":503},"title":{"type":"string","example":"Temporary Internal Error. Try again in 300 seconds."},"detail":{"type":"object","nullable":true}}}}}},"ResourceNotFound":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"string","format":"nullable"},"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","example":404},"message":{"type":"string","example":"Could not find host 'pleiades'."},"details":{"type":"string","format":"nullable"}}}}}}}},"WorkspaceNotFound":{"description":"Workspace not found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":404},"title":{"type":"string","example":"Workspace `68567134-27ad-7bd7-4b65-d61adb11fc78` not found."},"detail":{"nullable":true}}}}}},"GeometryNotFound":{"description":"Geometry not found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":404},"title":{"type":"string","example":"Geometry with id 'f010c2fd-728a-4c10-bdce-3240d93fc6aa' of account '561ca749-5286-4464-9a0d-6d6eb47b1a01' not found."},"detail":{"nullable":true}}}}}},"CatalogUnauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","example":401},"message":{"type":"string","example":"An error occurred while attempting to decode the Jwt: Jwt expired at 2023-02-15T11:29:44Z\n"},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"OrderingUnauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","example":401},"message":{"type":"string","example":"An error occurred while attempting to decode the Jwt: Jwt expired at 2023-02-15T11:29:44Z\n"},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"OrderingGeometryError":{"description":"Too many vertices","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","example":422},"message":{"type":"string","example":"1 validation error for Request\nbody -> intersects -> coordinates\nGeometry should not have more than 999 vertices. (type=value_error)\n"},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"CoverageUnauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":401},"title":{"type":"string","example":"An error occurred while attempting to decode the Jwt: Jwt expired at 2023-02-15T11:29:44Z\n"},"detail":{"type":"object","nullable":true}}}}}},"NotImplementedSchema":{"description":"Schema not yet implemented","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","example":404},"message":{"type":"string","example":"Dynamic schema is not yet implemented."},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"NonIntegratedProduct":{"description":"Data product not integrated. Order from the marketplace","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","example":500},"message":{"type":"string","example":"Could not find collection `elevation-50cm-tasking`."},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"HostError":{"description":"Request failed due to an outage on the host side","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","nullable":true,"example":null},"error":{"type":"object","properties":{"code":{"type":"integer","format":"int32","example":542},"message":{"type":"string","example":"Operation failed."},"details":{"type":"object","nullable":true,"example":null}}}}}}}},"NotImplementedV2":{"description":"Not supported for this provider","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","example":501},"title":{"type":"string","example":"Requested operation is currently not supported. Reason: ...\n"},"detail":{"type":"object","nullable":true}}}}}}},"parameters":{"AssetId":{"name":"asset-id","in":"path","description":"The asset ID.","required":true,"style":"simple","explode":false,"schema":{"$ref":"#/components/schemas/AssetId"}},"Tags":{"name":"tags","in":"query","description":"Order tags. Use to search for orders with any of the provided tags.\n","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},"PageableSize":{"name":"size","in":"query","description":"The number of results on a result page.\n","required":false,"style":"form","explode":true,"schema":{"type":"integer","example":10,"default":20}},"PageablePage":{"name":"page","in":"query","description":"The result page number. To get the first page, set the parameter to `0`.\n","required":false,"style":"form","explode":true,"schema":{"type":"integer","example":1,"default":0}},"PageableSort":{"name":"sort","in":"query","description":"The results sorting method that arranges elements in ascending or descending order based on a chosen field. The format is `<field name>,<asc or desc>`.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"id,asc","default":"createdAt,desc"}},"WorkspaceIdQuery":{"name":"workspaceId","in":"query","description":"The workspace ID.\n\nUse to get objects from a specific workspace. Otherwise, objects from the entire account will be returned.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}},"OrderIdPath":{"name":"order-id","in":"path","description":"The order ID.","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}},"OrderIdQuery":{"name":"orderId","in":"query","description":"The order ID.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}},"OrderType":{"name":"type","in":"query","description":"The order type. Use to search for catalog or tasking orders.\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/OrderType"},"examples":{"Catalog orders":{"description":"Use to get only catalog orders.","value":"ARCHIVE"},"Tasking orders":{"description":"Use to get only tasking orders.","value":"TASKING"},"All orders":{"description":"Don't use the parameter to get orders of all types.","value":null}}},"PageableSorting":{"name":"sort","in":"query","description":"The results sorting method that arranges elements in ascending or descending order based on a chosen field. The format is `<field name>,<asc or desc>`.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"id,asc","default":"createdAt,desc"}},"HostNamePath":{"name":"host-name","in":"path","description":"The name of the data host.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"oneatlas"}},"ImageIDPath":{"name":"image-id","in":"path","description":"The full scene ID.","required":true,"style":"simple","explode":false,"schema":{"type":"string","example":"TRIPLESAT_3_PMS_20230208011027_0042C9VI_002"}},"OrderIdPathKebab":{"name":"order-id","in":"path","description":"The order ID.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}},"OrderDisplayNameQuery":{"name":"displayName","in":"query","description":"Additional search terms. Use to search for orders that contain the provided search query in their name.\n","required":false,"style":"form","explode":true,"schema":{"type":"string"}},"OrderV2Status":{"name":"status","in":"query","description":"[Order statuses](https://docs.sa.up42.com/developers/api-tasking#order-statuses). Use to search for orders with any of the provided statuses.\n","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderV2Status"}}},"WorkspaceIdQueryRequired":{"name":"workspaceId","in":"query","description":"The workspace ID.\n","required":true,"style":"form","explode":true,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}},"GeometryIdPath":{"name":"geometry-id","in":"path","description":"The geometry ID.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid","example":"15b2dc9a-0cd3-4d4c-8180-07ebcd615468"}},"DisplayNameQuery":{"name":"displayName","in":"query","description":"The name of the geometry.","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"Berlin Tiergarten"}},"OrderSubStatusQuery":{"name":"subStatus","in":"query","description":"[Order sub-statuses](https://docs.sa.up42.com/developers/api-tasking#order-substatuses). Use to search for orders with any of the provided sub-statuses.\n","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["FEASIBILITY_WAITING_UPLOAD","FEASIBILITY_WAITING_RESPONSE","QUOTATION_WAITING_UPLOAD","QUOTATION_WAITING_RESPONSE","QUOTATION_ACCEPTED","QUOTATION_REJECTED"]}}},"EulaId":{"name":"eula-id","in":"path","description":"The EULA ID.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid","example":"68567134-27ad-7bd7-4b65-d61adb11fc78"}},"EulaDocumentId":{"name":"eula-document-id","in":"path","description":"The EULA document ID.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid","example":"a0d443a2-41e8-4995-8b54-a5cc4c448227"}},"CollectionNameInPath":{"name":"collection-name","in":"path","description":"The collection name.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"vexcel-elevate-dtm-15cm"},"DataProductNameInPath":{"name":"data-product-name","in":"path","description":"The data product name.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"worlddem-neo-dsm"},"DataProductId":{"name":"dataProductId","in":"query","description":"The data product ID.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","format":"uuid","example":"8fbccd60-c828-4d8c-a4ef-3c2730d9d6bc"}},"GlossaryV2PageableSize":{"name":"size","in":"query","description":"The number of results on a result page.\n","required":false,"style":"form","explode":true,"schema":{"type":"integer","example":20,"default":10}},"GlossaryV2PageableSorting":{"name":"sort","in":"query","description":"The results sorting method that arranges elements in ascending or descending order based on a chosen field. The format is `<field name>,<asc or desc>`.\n","required":false,"style":"form","explode":true,"schema":{"type":"string","example":"updatedAt,asc","default":"name,desc"}},"Integrations":{"name":"integrations","in":"query","description":"[Integration values](https://docs.sa.up42.com/developers/api-glossary#integrations) that indicate mandatory ordering steps, available actions, and mandatory or optional operations for a given collection.\n","required":false,"style":"form","explode":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/CollectionIntegration"}}},"CollectionType":{"name":"type","in":"query","description":"Collection types. Use to search for either tasking or catalog collections.\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/CollectionType"}},"STACCollectionID":{"name":"collection-id","in":"path","description":"The STAC collection ID.","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"}},"ProviderNameInPath":{"name":"provider-name","in":"path","description":"The name of the provider.\n","required":true,"style":"simple","explode":false,"schema":{"type":"string"},"example":"vexcel-v2"},"ProviderRole":{"name":"role","in":"query","description":"The provider role. Use to filter results to hosts or producers only.\n","required":false,"style":"form","explode":true,"schema":{"$ref":"#/components/schemas/ProviderRole"}},"DataProductIdsQuery":{"name":"dataProductIds","in":"query","description":"Data product IDs. Use to search for orders associated with any of the provided data products. Input must be a comma-separated list.\n","required":false,"style":"form","explode":false,"schema":{"maxItems":100,"type":"array","example":["c3de9ed8-f6e5-4bb5-a157-f6430ba756da","9d696797-056b-496f-8913-d1753a2a34bb"],"items":{"$ref":"#/components/schemas/DataProductId"}}},"OrderIdsQuery":{"name":"orderIds","in":"query","description":"Order IDs. Use to search for orders matching any of the provided IDs. Input must be a comma-separated list.\n","required":false,"style":"form","explode":false,"schema":{"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/OrderId"}}}},"examples":{"pansharpeningJobExample":{"value":{"processID":"pansharpening","jobID":"04fc6806-fd2c-4a5b-a335-fd563e5399ce","accountID":"04eb7366-f2a4-401f-953d-517aea4353d1","workspaceID":"d40c3960-d79a-4925-9828-fadc15ce5ec3","definition":{"inputs":{"title":"Pansharpening SPOT imagery","item":"https://api.sa.up42.com/v2/assets/stac/collections/21c0b14e-3434-4675-98d1-f225507ded99/items/23e4567-e89b-12d3-a456-426614174000","greyWeights":[{"band":"blue","weight":0.2},{"band":"green","weight":0.34},{"band":"red","weight":0.23}]}},"results":{"collection":"https://api.sa.up42.com/v2/assets/stac/collections/ca57a57d-5f2c-4b1c-957b-ea2c54be6262"},"status":"captured","type":"process","created":"2025-11-19T09:12:28Z","started":"2025-11-19T09:12:45Z","finished":"2025-11-19T09:18:26Z","updated":"2025-11-19T09:18:26Z","creditConsumption":{"credits":5}}},"upsamplingJobExample":{"value":{"processID":"upsampling-ns","jobID":"04fc6806-fd2c-4a5b-a335-fd563e5399ce","accountID":"d40c3960-d79a-4925-9828-fadc15ce5ec3","workspaceID":"d40c3960-d79a-4925-9828-fadc15ce5ec3","definition":{"inputs":{"title":"Upsampling imagery","item":"https://api.sa.up42.com/v2/assets/stac/collections/21c0b14e-3434-4675-98d1-f225507ded99/items/23e4567-e89b-12d3-a456-426614174000"}},"results":{"collection":"https://api.sa.up42.com/v2/assets/stac/collections/ca57a57d-5f2c-4b1c-957b-ea2c54be6262"},"status":"captured","type":"process","created":"2025-11-19T09:12:28Z","started":"2025-11-19T09:12:45Z","finished":"2025-11-19T09:18:26Z","updated":"2025-11-19T09:18:26Z","creditConsumption":{"credits":10}}}},"headers":{"ResponseHeaderRetryAfter":{"description":"The time you should wait before making a follow-up request.","style":"simple","explode":false,"schema":{"anyOf":[{"minimum":0,"type":"integer","description":"delay-seconds: A non-negative decimal integer indicating the seconds to delay after the response is received."},{"type":"string","description":"http-date: A date after which to retry.","format":"date-time"}]}}},"securitySchemes":{"httpBearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"oauth2Profiles":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.sa.up42.com/realms/public/protocol/openid-connect/token","scopes":{"account":"Access to resources of the authenticated user's account","eula.w":"Create/Update/Delete a EULA document"}},"authorizationCode":{"authorizationUrl":"https://auth.sa.up42.com/realms/public/protocol/openid-connect/auth","tokenUrl":"https://auth.sa.up42.com/realms/public/protocol/openid-connect/token","scopes":{"account":"Access to resources of the authenticated user's account","eula.w":"Create/Update/Delete a EULA document"}}}}}},"x-readme":{"explorer-enabled":true,"proxy-enabled":true}}