Pixxel
Documentation
Developer Guide
Pixxel API
External
Ping ServerGET
Project
List projectsGETGet projectGET
AOI
List all AOIsGETCreate a new AOIPOSTGet AOIGETList supported satellitesGET
Search
Search satellite imagesPOST
Indices
List all available indicesGETCreate a new indexPOST
Visualizations
List visualizations for an AOIGETCreate a new visualizationPOSTUpdate visualization metadataPUTRollback visualization metadataPATCHGenerate an index PNG for a visualizationPOSTGenerate SLD styles for a visualizationPOST
Blocks
List BlocksGETGet Block VersionsGETGet Block by VersionGET
Insights
Create Insights on an AOIPOSTList InsightsGETDownload InsightsPUTDelete InsightsDEL
Assets
List assets for an AOIGET
Downloads
Create a download request for assets in an AOIPOSTGet status of a download requestGET
Workflows
List workflowsGETGet Workflows By IdGETGet Workflow Cost estimateGET
Jobs
List JobsGETCreate a job from a given workflowPOSTGet Job by Id and WF IdGETDownload JobPUT
Tasks
Download TaskPUT
Bandset
List all bandsetsGET
Order
List all ordersGETCreate an orderPOSTGet an orderGETList all orderItemsGETGet an orderItemGET
Archives
List all collectionsGETGet a collectionGETList items in a collectionGETGet itemGETSearch all itemsPOST
Report
download order reportGET
Stores
List storesGETCreate a storePOSTDelete a storeDEL
Catalog
List all deliveriesGETCreate deliveriesPOSTCreate a download resourcePOSTGet download statusGETSearch all catalogsPOSTGet a catalogGET
Pixxel
Documentation
Developer Guide
Pixxel API
External
Ping ServerGET
Project
List projectsGETGet projectGET
AOI
List all AOIsGETCreate a new AOIPOSTGet AOIGETList supported satellitesGET
Search
Search satellite imagesPOST
Indices
List all available indicesGETCreate a new indexPOST
Visualizations
List visualizations for an AOIGETCreate a new visualizationPOSTUpdate visualization metadataPUTRollback visualization metadataPATCHGenerate an index PNG for a visualizationPOSTGenerate SLD styles for a visualizationPOST
Blocks
List BlocksGETGet Block VersionsGETGet Block by VersionGET
Insights
Create Insights on an AOIPOSTList InsightsGETDownload InsightsPUTDelete InsightsDEL
Assets
List assets for an AOIGET
Downloads
Create a download request for assets in an AOIPOSTGet status of a download requestGET
Workflows
List workflowsGETGet Workflows By IdGETGet Workflow Cost estimateGET
Jobs
List JobsGETCreate a job from a given workflowPOSTGet Job by Id and WF IdGETDownload JobPUT
Tasks
Download TaskPUT
Bandset
List all bandsetsGET
Order
List all ordersGETCreate an orderPOSTGet an orderGETList all orderItemsGETGet an orderItemGET
Archives
List all collectionsGETGet a collectionGETList items in a collectionGETGet itemGETSearch all itemsPOST
Report
download order reportGET
Stores
List storesGETCreate a storePOSTDelete a storeDEL
Catalog
List all deliveriesGETCreate deliveriesPOSTCreate a download resourcePOSTGet download statusGETSearch all catalogsPOSTGet a catalogGET
  1. Workflows
  3. Get Workflows By Id

Get Workflows By Id

Get workflows by a ID

GET/v0/workflows/{workflow_id}
Authorisations
AuthorizationString
Path Parameters
workflow_idstringrequired
Unique UUID identifier for the target workflow
Query Parameters
project_idstringrequired
Project identifier that the workflow belongs to
Response
application/json
OK
idstring
Unique identifier for the workflow
estimated_costinteger
Token cost estimated for this workflow
namestring
Display name of the workflow
created_bystring
Identifies the user who created this workflow
descriptionstring
Provides details about the workflow's purpose
specinteger[]
Contains the raw specification data for the workflow
created_atstring
Timestamp when the workflow was created
updated_atstring
Timestamp when the workflow was last modified
val_errorsobject[]
Validation errors encountered with this workflow
Show child attributes
project_idstring
Identifier of the project this workflow belongs to
Get Workflows By Id
cURL
Python
Go
TypeScript
1curl -X GET 'https://api.pixxel.space/v0/workflows/{workflow_id}' \
2  -H 'Authorization: YOUR_API_KEY'
Response:
{
  "id": "string",
  "estimated_cost": 0,
  "name": "string",
  "created_by": "string",
  "description": "string",
  "spec": [
    0
  ],
  "created_at": "string",
  "updated_at": "string",
  "val_errors": [
    {
      "from": "string",
      "to": "string",
      "err": "string",
      "reason": "string",
      "component_name": "string"
    }
  ],
  "project_id": "string"
}
List workflowsGet Workflow Cost estimate