## Overview
<p align="justify">
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
</p>

## Authorization
<p align="justify">
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

```json
Authorization: <YOUR_API_KEY>
```
</p>

## Path Parameters
<p align="justify">
The `workflow_id` identifies the exact workflow whose cost is to be retrieved.

| Field         | Type   | Required | Description                                                  |
|--------------|--------|----------|--------------------------------------------------------------|
| `workflow_id`  | `string` | Yes      | Unique identifier of the workflow                            |
</p>

## Response

<p align="justify">
A **200 OK** response returns estimated cost of running the workflow.

| Name              | Type       | Description                                                       |
|-------------------|------------|-------------------------------------------------------------------|
| `estimated_cost`  | `integer`  | Estimated or actual cost of job execution                     |

Here is a sample **200** response: 
```json 200
{
  "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.

```json 400 403
{
  "error": {
    "code": "<string>",
    "details": "<any>",
    "message": "<string>"
  }
}
```
</p>

## How to use the endpoint
<p align="justify">
- **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.
</p>