Run an endpoint

curl --request POST \
  --url https://api.example.com/v1/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "provider": "<string>",
  "endpoint": "<string>",
  "input": {},
  "endpoint_version": 1
}
'

import requests

url = "https://api.example.com/v1/runs"

payload = {
    "provider": "<string>",
    "endpoint": "<string>",
    "input": {},
    "endpoint_version": 1
}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({provider: '<string>', endpoint: '<string>', input: {}, endpoint_version: 1})
};

fetch('https://api.example.com/v1/runs', 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.example.com/v1/runs",
  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([
    'provider' => '<string>',
    'endpoint' => '<string>',
    'input' => [
        
    ],
    'endpoint_version' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "idempotency-key: <idempotency-key>"
  ],
]);

$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.example.com/v1/runs"

	payload := strings.NewReader("{\n  \"provider\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"input\": {},\n  \"endpoint_version\": 1\n}")

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

	req.Header.Add("idempotency-key", "<idempotency-key>")
	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.example.com/v1/runs")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"input\": {},\n  \"endpoint_version\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/runs")

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

request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"input\": {},\n  \"endpoint_version\": 1\n}"

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

{
  "id": "<string>",
  "run_url": "<string>",
  "provider": "<string>",
  "endpoint": "<string>",
  "endpoint_version": 123,
  "status": "QUEUED",
  "failure": {
    "kind": "TIMED_OUT",
    "message": "<string>"
  },
  "input": {},
  "output": "<unknown>",
  "provider_response": {
    "http_status": 349,
    "error": null
  },
  "charge_usd": "<string>",
  "charge_basis": {
    "clause": "rule",
    "quantity": 1
  },
  "stoppable": true,
  "stop_requested_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "id": "<string>",
  "run_url": "<string>",
  "provider": "<string>",
  "endpoint": "<string>",
  "endpoint_version": 123,
  "status": "QUEUED",
  "failure": {
    "kind": "TIMED_OUT",
    "message": "<string>"
  },
  "input": {},
  "output": "<unknown>",
  "provider_response": {
    "http_status": 349,
    "error": null
  },
  "charge_usd": "<string>",
  "charge_basis": {
    "clause": "rule",
    "quantity": 1
  },
  "stoppable": true,
  "stop_requested_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "unauthorized",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "insufficient_balance",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "endpoint_not_permitted",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "rate_limited",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "service_unavailable",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

Runs

Run an endpoint

Admits one execution: the policy is checked, a hold is reserved for the price’s maximum charge, and a run is created. Input is provider-native — construct it against the inspected input_schema. A sync endpoint always answers 200 with the terminal run inside its published timeout_ms — it never returns 202, so no polling code is needed. An async endpoint answers 200 when the run is terminal within a short server budget, otherwise 202 with the in-flight run, which you can poll or stop. Status reports whether a usable provider response won settlement, never whether the provider accepted the request: a provider 404 or 500 is a COMPLETED run whose provider_response carries the received status, charged by the price’s NO_RESULT or PROVIDER_ERROR clause. The Idempotency-Key header is required — a retry with the same key returns the same run and is never charged twice, while the same key with a different request body returns 409. Balance and policy refusals happen before admission and create no run.

POST

runs

Run an endpoint

curl --request POST \
  --url https://api.example.com/v1/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "provider": "<string>",
  "endpoint": "<string>",
  "input": {},
  "endpoint_version": 1
}
'

import requests

url = "https://api.example.com/v1/runs"

payload = {
    "provider": "<string>",
    "endpoint": "<string>",
    "input": {},
    "endpoint_version": 1
}
headers = {
    "idempotency-key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'idempotency-key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({provider: '<string>', endpoint: '<string>', input: {}, endpoint_version: 1})
};

fetch('https://api.example.com/v1/runs', 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.example.com/v1/runs",
  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([
    'provider' => '<string>',
    'endpoint' => '<string>',
    'input' => [
        
    ],
    'endpoint_version' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "idempotency-key: <idempotency-key>"
  ],
]);

$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.example.com/v1/runs"

	payload := strings.NewReader("{\n  \"provider\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"input\": {},\n  \"endpoint_version\": 1\n}")

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

	req.Header.Add("idempotency-key", "<idempotency-key>")
	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.example.com/v1/runs")
  .header("idempotency-key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"input\": {},\n  \"endpoint_version\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/runs")

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

request = Net::HTTP::Post.new(url)
request["idempotency-key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"provider\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"input\": {},\n  \"endpoint_version\": 1\n}"

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

{
  "id": "<string>",
  "run_url": "<string>",
  "provider": "<string>",
  "endpoint": "<string>",
  "endpoint_version": 123,
  "status": "QUEUED",
  "failure": {
    "kind": "TIMED_OUT",
    "message": "<string>"
  },
  "input": {},
  "output": "<unknown>",
  "provider_response": {
    "http_status": 349,
    "error": null
  },
  "charge_usd": "<string>",
  "charge_basis": {
    "clause": "rule",
    "quantity": 1
  },
  "stoppable": true,
  "stop_requested_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "id": "<string>",
  "run_url": "<string>",
  "provider": "<string>",
  "endpoint": "<string>",
  "endpoint_version": 123,
  "status": "QUEUED",
  "failure": {
    "kind": "TIMED_OUT",
    "message": "<string>"
  },
  "input": {},
  "output": "<unknown>",
  "provider_response": {
    "http_status": 349,
    "error": null
  },
  "charge_usd": "<string>",
  "charge_basis": {
    "clause": "rule",
    "quantity": 1
  },
  "stoppable": true,
  "stop_requested_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "validation_failed",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "unauthorized",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "insufficient_balance",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "endpoint_not_permitted",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "idempotency_conflict",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "rate_limited",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

{
  "error": {
    "code": "service_unavailable",
    "message": "<string>",
    "reason": "<string>",
    "control": "<string>",
    "retry_after_ms": 123,
    "details": {}
  },
  "request_id": "<string>"
}

Headers

idempotency-key

string

required

A caller-generated idempotency key (a UUID is recommended). One key binds to one run: a retry with the same key after a network timeout is a read, not a second execution.

Minimum string length: 1

Body

application/json

provider

string

required

Pattern: ^[a-z0-9][a-z0-9-]*$

endpoint

string

required

Pattern: ^\/.+$

input

object

endpoint_version

integer | null

Required range: x > 0

Response

a terminal run: COMPLETED, FAILED or STOPPED

string

required

run_url

string

required

provider

string

required

Pattern: ^[a-z0-9][a-z0-9-]*$

endpoint

string

required

Pattern: ^\/.+$

endpoint_version

integer

required

status

enum<string>

required

Available options:

QUEUED,

RUNNING,

COMPLETED,

FAILED,

STOPPED

failure

object | null

required

Show child attributes

input

object

required

output

any

required

provider_response

object | null

required

Show child attributes

charge_usd

string | null

required

Exact USD decimal string (min 2, max 6 decimals, one canonical spelling). Sum with decimal arithmetic or scale by 10^6 — never floats.

Pattern: ^(0|[1-9]\d*)\.(\d{2}|\d{2}\d{0,3}[1-9])$

charge_basis

object | null

required

Show child attributes

stoppable

boolean

required

stop_requested_at

string<date-time> | null

required

ISO-8601 UTC timestamp

created_at

string<date-time>

required

ISO-8601 UTC timestamp

started_at

string<date-time> | null

required

ISO-8601 UTC timestamp

completed_at

string<date-time> | null

required

ISO-8601 UTC timestamp