Skip to main content
POST
/
v1
/
runs
/
start
start a budgeted run
curl --request POST \
  --url https://api.unprice.dev/v1/runs/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budgetAmountMinor": 1,
  "idempotencyKey": "<string>",
  "customerId": "<string>",
  "workloadId": "<string>",
  "traceId": "<string>",
  "parentRunId": "<string>",
  "metadata": {},
  "expiresAt": 1
}
'
import requests

url = "https://api.unprice.dev/v1/runs/start"

payload = {
"budgetAmountMinor": 1,
"idempotencyKey": "<string>",
"customerId": "<string>",
"workloadId": "<string>",
"traceId": "<string>",
"parentRunId": "<string>",
"metadata": {},
"expiresAt": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
budgetAmountMinor: 1,
idempotencyKey: '<string>',
customerId: '<string>',
workloadId: '<string>',
traceId: '<string>',
parentRunId: '<string>',
metadata: {},
expiresAt: 1
})
};

fetch('https://api.unprice.dev/v1/runs/start', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.unprice.dev/v1/runs/start",
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([
'budgetAmountMinor' => 1,
'idempotencyKey' => '<string>',
'customerId' => '<string>',
'workloadId' => '<string>',
'traceId' => '<string>',
'parentRunId' => '<string>',
'metadata' => [

],
'expiresAt' => 1
]),
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;
}
package main

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

func main() {

url := "https://api.unprice.dev/v1/runs/start"

payload := strings.NewReader("{\n \"budgetAmountMinor\": 1,\n \"idempotencyKey\": \"<string>\",\n \"customerId\": \"<string>\",\n \"workloadId\": \"<string>\",\n \"traceId\": \"<string>\",\n \"parentRunId\": \"<string>\",\n \"metadata\": {},\n \"expiresAt\": 1\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(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.unprice.dev/v1/runs/start")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"budgetAmountMinor\": 1,\n \"idempotencyKey\": \"<string>\",\n \"customerId\": \"<string>\",\n \"workloadId\": \"<string>\",\n \"traceId\": \"<string>\",\n \"parentRunId\": \"<string>\",\n \"metadata\": {},\n \"expiresAt\": 1\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.unprice.dev/v1/runs/start")

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 \"budgetAmountMinor\": 1,\n \"idempotencyKey\": \"<string>\",\n \"customerId\": \"<string>\",\n \"workloadId\": \"<string>\",\n \"traceId\": \"<string>\",\n \"parentRunId\": \"<string>\",\n \"metadata\": {},\n \"expiresAt\": 1\n}"

response = http.request(request)
puts response.read_body
{
  "runId": "<string>",
  "customerId": "<string>",
  "budgetAmountMinor": 123,
  "consumedAmountMinor": 123,
  "remainingAmountMinor": 123,
  "currency": "<string>",
  "workloadId": "<string>",
  "traceId": "<string>",
  "parentRunId": "<string>",
  "endedAt": 1
}
{
"error": {
"code": "BAD_REQUEST",
"docs": "https://docs.unprice.dev/api-reference/errors/code/BAD_REQUEST",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "UNAUTHORIZED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/UNAUTHORIZED",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "FORBIDDEN",
"docs": "https://docs.unprice.dev/api-reference/errors/code/FORBIDDEN",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "NOT_FOUND",
"docs": "https://docs.unprice.dev/api-reference/errors/code/NOT_FOUND",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "CONFLICT",
"docs": "https://docs.unprice.dev/api-reference/errors/code/CONFLICT",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "PRECONDITION_FAILED",
"docs": "https://docs.unprice.dev/api-reference/errors/code/PRECONDITION_FAILED",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "TOO_MANY_REQUESTS",
"docs": "https://docs.unprice.dev/api-reference/errors/code/TOO_MANY_REQUESTS",
"message": "<string>",
"requestId": "req_1234"
}
}
{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"docs": "https://docs.unprice.dev/api-reference/errors/code/INTERNAL_SERVER_ERROR",
"message": "<string>",
"requestId": "req_1234"
}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The run configuration

budgetAmountMinor
integer
required

Budget in currency minor units, usually cents. For USD, 5000 means $50.00.

Required range: x > 0
idempotencyKey
string
required
Minimum string length: 1
customerId
string
Minimum string length: 1
workloadType
enum<string> | null
Available options:
agent,
workflow,
job,
tool,
custom,
null
workloadId
string | null
Minimum string length: 1
traceId
string | null
Minimum string length: 1
parentRunId
string | null
Minimum string length: 1
metadata
object
expiresAt
integer | null
Required range: x > 0

Response

The budget run summary

runId
string
required
status
enum<string>
required
Available options:
running,
completed,
expired,
canceled,
budget_exceeded,
failed
customerId
string
required
budgetAmountMinor
integer
required
consumedAmountMinor
integer
required
remainingAmountMinor
integer
required
currency
string
required
workloadType
enum<string> | null
required
Available options:
agent,
workflow,
job,
tool,
custom,
null
workloadId
string | null
required
traceId
string | null
required
parentRunId
string | null
required
endedAt
integer | null

Authoritative run terminal timestamp in epoch milliseconds; null while running.

Required range: x >= 0