Get Workflow Cost Estimate

Overview

This endpoint allows users to retrieve cost estimate of specific workflow when run actually. Authentication via a bearer token is required.

• Method: GET

• URL: /v0/workflows/{workflow_id}/estimate

• Operation: Get cost estimate of a workflow

• Authentication Required: Yes

Authorization

All API requests require authentication using a Personal Access Token. Include your token in the request header with the Bearer scheme:

Authorization: Bearer <YOUR_PERSONAL_ACCESS_TOKEN>

See the Authentication guide for how to generate a Personal Access Token.

Path Parameters

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

Response

A 200 OK response returns estimated cost of running the workflow.

Here is a sample 200 response:

{
  "estimated_cost": 123
}

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 workflow. The response includes structured error details such as code, message, and optional context for resolving access issues.

{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}

How to use the endpoint

• Construct your Request:
  Gather the workflow_id of the workflow whose cost is to be estimated.

• Send the Request:
  After including your bearer token in the Authorization header make a GET request to https://api.pixxel.space/v0/workflows/{workflow_id}/estimate.

• Examine the Response:
  On success, you recieve the estimated cost. Handle errors with appropriate fallback and retry mechanisms.