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. Jobs
  3. Create a job from a given workflow

Create a job from a given workflow

Create a job from a given workflow

POST/v0/workflows/{workflow_id}/jobs
Authorisations
AuthorizationString
Path Parameters
workflow_idstringrequired
Unique identifier for the workflow to create a job from
Query Parameters
project_idstringrequired
Project identifier the workflow belongs to
Response
application/json
OK
created_bystring
Unique identifier of the user who created the job
statusstring
Current status of the job
time_takenstring
Actual duration the job took to complete
idstring
Unique identifier for the job
tasksobject[]
List of tasks in this job
Show child attributes
val_errorsobject[]
Validation errors encountered
Show child attributes
specinteger[]
Raw specification data for the job
costinteger
Token cost of the job
workflow_idstring
Unique identifier of the workflow this job belongs to
updated_atstring
Timestamp when the job was last updated
finished_atstring
Timestamp when the job was completed
exec_created_atstring
Timestamp when the job execution was created
exec_updated_atstring
Timestamp when the job execution was last updated
created_atstring
Timestamp when the job was created
estimated_durationinteger
Expected time in seconds to complete the job
progressstring
Completion percentage of the job
Create a job from a given workflow
cURL
Python
Go
TypeScript
1curl -X POST 'https://api.pixxel.space/v0/workflows/{workflow_id}/jobs' \
2  -H 'Authorization: YOUR_API_KEY'
Response:
{
  "created_by": "string",
  "status": "string",
  "time_taken": "string",
  "id": "string",
  "tasks": [
    {
      "id": "string",
      "info_logs": [
        0
      ],
      "created_at": "string",
      "updated_at": "string",
      "finished_at": "string",
      "estimated_time_duration": 0,
      "time_taken": "string",
      "status": "string",
      "state_msg": "string",
      "inputs": [
        0
      ],
      "result": [
        0
      ],
      "depends_on": [
        "string"
      ],
      "name": "string",
      "progress": 0,
      "disclaimer": [
        "string"
      ],
      "recv_time": "string",
      "send_time": "string",
      "block_inf_start_time": "string",
      "block_inf_end_time": "string",
      "block_info": {
        "id": "string",
        "name": "string",
        "version": "string"
      },
      "err_msg": "string",
      "failure_type": "string"
    }
  ],
  "val_errors": [
    {
      "from": "string",
      "to": "string",
      "err": "string",
      "reason": "string",
      "component_name": "string"
    }
  ],
  "spec": [
    0
  ],
  "cost": 0,
  "workflow_id": "string",
  "updated_at": "string",
  "finished_at": "string",
  "exec_created_at": "string",
  "exec_updated_at": "string",
  "created_at": "string",
  "estimated_duration": 0,
  "progress": "string"
}
List JobsGet Job by Id and WF Id