Estimate workflow price

Viewing v1— superseded by v2

POST

/v1/workspaces/{workspace_id}/workflows/{workflow_id}/estimate

curl --request POST \
  --url https://api.app.layer.ai/api/v1/workspaces/:workspace_id/workflows/:workflow_id/estimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "inputs": {}
}'

import requests

url = "https://api.app.layer.ai/api/v1/workspaces/:workspace_id/workflows/:workflow_id/estimate"

payload = { "inputs": {} }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

const url = 'https://api.app.layer.ai/api/v1/workspaces/:workspace_id/workflows/:workflow_id/estimate';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"inputs":{}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://api.app.layer.ai/api/v1/workspaces/:workspace_id/workflows/:workflow_id/estimate"

  payload := strings.NewReader("{\n  \"inputs\": {}\n}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.app.layer.ai/api/v1/workspaces/:workspace_id/workflows/:workflow_id/estimate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'inputs' => [

    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"inputs\": {}\n}");
Request request = new Request.Builder()
  .url("https://api.app.layer.ai/api/v1/workspaces/:workspace_id/workflows/:workflow_id/estimate")
  .post(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

require 'uri'
require 'net/http'

url = URI("https://api.app.layer.ai/api/v1/workspaces/:workspace_id/workflows/:workflow_id/estimate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"inputs\": {}\n}"

response = http.request(request)
puts response.read_body

var client = new RestClient("https://api.app.layer.ai/api/v1/workspaces/:workspace_id/workflows/:workflow_id/estimate");
var request = new RestRequest("", Method.Post);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"inputs\": {}\n}", ParameterType.RequestBody);
var response = client.Execute(request);

v1 is superseded. v1 was superseded by v2 on 2026-08-26. A sunset date has not been announced yet; v1 will be deprecated as a whole before removal. Migrate with the v2 migration guide.

Estimate the Creative Units cost of running a workflow with given inputs.

Authorizations

bearerAuth
oauth2
serviceAccount
workflows:read

Parameters

Path Parameters

workspace_id

required

Workspace Id

Id of the workspace that owns the resource.

string format: uuid

Id of the workspace that owns the resource.

workflow_id

required

Workflow Id

Id of the workflow.

string format: uuid

Id of the workflow.

Header Parameters

Idempotency-Key

string

<= 255 characters

Opaque key making a retry of this request return the first result. A 2xx response is replayed for 24 hours with Idempotent-Replayed: true. A 4xx releases the key. A 5xx, or a request still running, holds the key for 120 seconds, during which a retry gets 409; after that a retry executes again. The key covers the method, path, query, and byte-identical body it was first used with; reusing it for a different request is rejected with 422. Protection is best effort: if the key store is unavailable, or a record is lost early, a retry can execute again even after an earlier 409. See the Idempotency section of the API description.

Request Body^required

application/json

EstimateWorkflowPriceRequest

object

inputs

required

Inputs

Workflow inputs matching the workflow’s input schema.

object

key

additional properties

any

Example^generated

{
  "inputs": {}
}

Responses

200

Successful Response

application/json

EstimateWorkflowPriceOutput

object

estimated_price_creative_units

required

Estimated Price Creative Units

Total estimated Creative Units price for this run.

number

output_counts

required

Output Counts

Expected output count for each workflow output parameter.

Array<object>

EstimateWorkflowOutputCount

object

output

required

WorkflowOutput

The output parameter definition.

object

name

required

Name

Output parameter name

string

type

required

Type

Output type: file, string, etc.

string

value_schema

Value Schema

JSON schema of the output value

object

key

additional properties

any

description

required

Description

What this output contains

string

display_name

Display Name

Human-readable label

string

nullable

count

required

Count

The expected number of outputs

integer

workspace_balance_creative_units

required

Workspace Balance Creative Units

Usable Creative Units balance (total balance minus reserved by in-progress generations).

number

estimated_remaining_balance_creative_units

required

Estimated Remaining Balance Creative Units

Usable balance after subtracting the estimated price. Can be negative.

number

has_sufficient_creative_units

required

Has Sufficient Creative Units

Whether the workspace has enough available Creative Units to cover the estimated price.

boolean

Example^generated

{
  "estimated_price_creative_units": 1,
  "output_counts": [
    {
      "output": {
        "name": "example",
        "type": "example",
        "value_schema": {},
        "description": "example",
        "display_name": "example"
      },
      "count": 1
    }
  ],
  "workspace_balance_creative_units": 1,
  "estimated_remaining_balance_creative_units": 1,
  "has_sufficient_creative_units": true
}

401

Unauthenticated — missing or invalid Bearer token.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

403

Forbidden — insufficient permissions, or the access token lacks the scope the operation requires.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

404

Resource not found.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

409

The outcome of the request with this Idempotency-Key is not known yet: it is still running, or it failed without a stored response. Retry after the number of seconds in Retry-After.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

422

Invalid input parameters, or an Idempotency-Key reused for a different request.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

429

Rate limited — retry after the number of seconds in Retry-After.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

500

Internal server error.

application/problem+json

object

type

required

string

title

required

string

status

required

integer

detail

required

string

Example

{
  "type": "https://api.layer.ai/errors/ERROR_CODE",
  "title": "Error Title",
  "status": 400,
  "detail": "Human-readable description."
}

Estimate workflow price

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Examplegenerated

Responses

200

Examplegenerated

401

Example

403

Example

404

Example

409

Example

422

Example

429

Example

500

Example

Request Body^required

Example^generated

Example^generated