Skip to main content

​
Overview

This endpoint allows users to retrieve detailed information about a specific workflow within a project by providing both the project_id and workflow_id. It returns metadata including workflow status, progress, timing details, associated tasks, and cost. Authentication via a bearer token is required.

  • Method: GET
  • URL: /v0/workflows/{workflow_id}
  • Operation: Get detailed information of a workflow
  • Authentication Required: Yes

​
Authorization

You need the api key which you can get from the API tab in Workspace Settings. The api key is required in almost all the commands

Authorization: <YOUR_API_KEY>

​
Path Parameters

The workflow_id identifies the exact workflow whose information is to be retrieved.

FieldTypeRequiredDescription
workflow_idstringYesUnique identifier of the workflow

​
Query Parameters

The project_id identifies the exact project from which the workflow is to be retrieved.

FieldTypeRequiredDescription
workflow_idstringYesUnique identifier of the workflow

​
Response

A 200 OK response returns full metadata for a workflow, including execution timestamps, creator, duration, cost, and progress. It also includes task and validation error details, if applicable. This response is useful for monitoring, debugging, or auditing purposes in workflow pipelines.

NameTypeDescription
idstringUnique identifier of the workflow
estimated_costintegerEstimated or actual cost of job execution
namestringDisplay name of the workflow given by user
created_bystringID of the user who created the workflow
created_atstringTimestamp when the workflow was originally created
updated_atstringTimestamp of the last update to the workflow
val_errorsobject[]List of validation errors encountered
project_idstringUnique identifier of the project
Here is a sample 200 response:
200
{
  "id": "<string>",
  "estimated_cost": 123,
  "name": "<string>",
  "created_by": "<string>",
  "description": "<string>",
  "spec": [
    123
  ],
  "created_at": "<string>",
  "updated_at": "<string>",
  "val_errors": [
    {
      "from": "<string>",
      "to": "<string>",
      "err": "<string>",
      "reason": "<string>",
      "component_name": "<string>"
    }
  ],
  "project_id": "<string>"
}
A 400 Bad Request response occurs if parameters are malformed or missing. A 403 Forbidden indicates the user does not have access to the requested project or workflow. The response includes structured error details such as code, message, and optional context for resolving access issues.
400 403
{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}

​
How to use the endpoint

  • Construct your Request:
    Gather the workflow_id and project_id of the workflow you want to inspect.
  • Send the Request:
    Make a GET request to https://api.pixxel.space/v0/workflows/{workflow_id}. Include your bearer token in the Authorization header.
  • Examine the Response:
    On success, parse the workflow metadata to understand execution cost, creation and updation timestamps, and any issues. Handle errors with appropriate fallback and retry mechanisms.