Create a custom agent cost item

curl --request POST \
  --url https://api.hyperline.co/v1/agents/cost-catalog/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "item": "<string>",
  "dimensions": [
    {
      "key": "<string>",
      "rate": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hyperline.co/v1/agents/cost-catalog/items"

payload = {
    "provider": "<string>",
    "item": "<string>",
    "dimensions": [
        {
            "key": "<string>",
            "rate": "<string>"
        }
    ]
}
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({
    provider: '<string>',
    item: '<string>',
    dimensions: [{key: '<string>', rate: '<string>'}]
  })
};

fetch('https://api.hyperline.co/v1/agents/cost-catalog/items', 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.hyperline.co/v1/agents/cost-catalog/items",
  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>',
    'item' => '<string>',
    'dimensions' => [
        [
                'key' => '<string>',
                'rate' => '<string>'
        ]
    ]
  ]),
  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.hyperline.co/v1/agents/cost-catalog/items"

	payload := strings.NewReader("{\n  \"provider\": \"<string>\",\n  \"item\": \"<string>\",\n  \"dimensions\": [\n    {\n      \"key\": \"<string>\",\n      \"rate\": \"<string>\"\n    }\n  ]\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.hyperline.co/v1/agents/cost-catalog/items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"<string>\",\n  \"item\": \"<string>\",\n  \"dimensions\": [\n    {\n      \"key\": \"<string>\",\n      \"rate\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/agents/cost-catalog/items")

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  \"provider\": \"<string>\",\n  \"item\": \"<string>\",\n  \"dimensions\": [\n    {\n      \"key\": \"<string>\",\n      \"rate\": \"<string>\"\n    }\n  ]\n}"

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

{
  "provider": "<string>",
  "model": "<string>",
  "aliases": [
    "<string>"
  ],
  "input_per_m_tokens": "<string>",
  "output_per_m_tokens": "<string>",
  "cached_input_per_m_tokens": "<string>",
  "cache_write_per_m_tokens": "<string>",
  "dimensions": [
    {
      "key": "<string>",
      "rate": "<string>",
      "per": "1m"
    }
  ],
  "effective_from": "<string>",
  "source": "<string>",
  "custom_item_id": "<string>",
  "override": {
    "id": "<string>",
    "input_per_m_tokens": "<string>",
    "output_per_m_tokens": "<string>",
    "cached_input_per_m_tokens": "<string>",
    "cache_write_per_m_tokens": "<string>",
    "effective_from": "<string>",
    "dimensions": [
      {
        "key": "<string>",
        "rate": "<string>",
        "per": "1m"
      }
    ]
  }
}

{
  "provider": "<string>",
  "model": "<string>",
  "aliases": [
    "<string>"
  ],
  "input_per_m_tokens": "<string>",
  "output_per_m_tokens": "<string>",
  "cached_input_per_m_tokens": "<string>",
  "cache_write_per_m_tokens": "<string>",
  "dimensions": [
    {
      "key": "<string>",
      "rate": "<string>",
      "per": "1m"
    }
  ],
  "effective_from": "<string>",
  "source": "<string>",
  "custom_item_id": "<string>",
  "override": {
    "id": "<string>",
    "input_per_m_tokens": "<string>",
    "output_per_m_tokens": "<string>",
    "cached_input_per_m_tokens": "<string>",
    "cache_write_per_m_tokens": "<string>",
    "effective_from": "<string>",
    "dimensions": [
      {
        "key": "<string>",
        "rate": "<string>",
        "per": "1m"
      }
    ]
  }
}

Agents

Create a custom agent cost item

Price a non-LLM cost item the registry has never heard of — a search API, a vector DB, GPU seconds, a render. The item is priced entirely by its dimensions (its token rates are 0). provider and item must match, verbatim, the vendor and item your SDK sends on hyperline.cost({ vendor, item, quantity, unit }) — they are lowercased and trimmed, nothing else — and each dimensions[].key must match the unit of the call it prices: cost() writes the quantity to usage_extra[unit] and pricing matches a dimension by that exact key, so a key that does not match prices nothing. Idempotent by design so a seed script can be re-run: an open custom item already standing for that (provider, item) is returned as it is, rates untouched, with a 200 instead of a fresh 201 — edit a rate by deleting the item and creating it again. A (provider, item) pair the global registry already prices is refused: that model has a price, and a negotiated rate for it goes through the overrides endpoint.

POST

agents

cost-catalog

items

Create a custom agent cost item

curl --request POST \
  --url https://api.hyperline.co/v1/agents/cost-catalog/items \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "provider": "<string>",
  "item": "<string>",
  "dimensions": [
    {
      "key": "<string>",
      "rate": "<string>"
    }
  ]
}
'

import requests

url = "https://api.hyperline.co/v1/agents/cost-catalog/items"

payload = {
    "provider": "<string>",
    "item": "<string>",
    "dimensions": [
        {
            "key": "<string>",
            "rate": "<string>"
        }
    ]
}
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({
    provider: '<string>',
    item: '<string>',
    dimensions: [{key: '<string>', rate: '<string>'}]
  })
};

fetch('https://api.hyperline.co/v1/agents/cost-catalog/items', 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.hyperline.co/v1/agents/cost-catalog/items",
  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>',
    'item' => '<string>',
    'dimensions' => [
        [
                'key' => '<string>',
                'rate' => '<string>'
        ]
    ]
  ]),
  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.hyperline.co/v1/agents/cost-catalog/items"

	payload := strings.NewReader("{\n  \"provider\": \"<string>\",\n  \"item\": \"<string>\",\n  \"dimensions\": [\n    {\n      \"key\": \"<string>\",\n      \"rate\": \"<string>\"\n    }\n  ]\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.hyperline.co/v1/agents/cost-catalog/items")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"provider\": \"<string>\",\n  \"item\": \"<string>\",\n  \"dimensions\": [\n    {\n      \"key\": \"<string>\",\n      \"rate\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperline.co/v1/agents/cost-catalog/items")

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  \"provider\": \"<string>\",\n  \"item\": \"<string>\",\n  \"dimensions\": [\n    {\n      \"key\": \"<string>\",\n      \"rate\": \"<string>\"\n    }\n  ]\n}"

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

{
  "provider": "<string>",
  "model": "<string>",
  "aliases": [
    "<string>"
  ],
  "input_per_m_tokens": "<string>",
  "output_per_m_tokens": "<string>",
  "cached_input_per_m_tokens": "<string>",
  "cache_write_per_m_tokens": "<string>",
  "dimensions": [
    {
      "key": "<string>",
      "rate": "<string>",
      "per": "1m"
    }
  ],
  "effective_from": "<string>",
  "source": "<string>",
  "custom_item_id": "<string>",
  "override": {
    "id": "<string>",
    "input_per_m_tokens": "<string>",
    "output_per_m_tokens": "<string>",
    "cached_input_per_m_tokens": "<string>",
    "cache_write_per_m_tokens": "<string>",
    "effective_from": "<string>",
    "dimensions": [
      {
        "key": "<string>",
        "rate": "<string>",
        "per": "1m"
      }
    ]
  }
}

{
  "provider": "<string>",
  "model": "<string>",
  "aliases": [
    "<string>"
  ],
  "input_per_m_tokens": "<string>",
  "output_per_m_tokens": "<string>",
  "cached_input_per_m_tokens": "<string>",
  "cache_write_per_m_tokens": "<string>",
  "dimensions": [
    {
      "key": "<string>",
      "rate": "<string>",
      "per": "1m"
    }
  ],
  "effective_from": "<string>",
  "source": "<string>",
  "custom_item_id": "<string>",
  "override": {
    "id": "<string>",
    "input_per_m_tokens": "<string>",
    "output_per_m_tokens": "<string>",
    "cached_input_per_m_tokens": "<string>",
    "cache_write_per_m_tokens": "<string>",
    "effective_from": "<string>",
    "dimensions": [
      {
        "key": "<string>",
        "rate": "<string>",
        "per": "1m"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Create custom cost item payload

provider

string

required

Minimum string length: 1

item

string

required

Minimum string length: 1

dimensions

object[]

required

Required array length: 1 - 10 elements

Show child attributes

Response

The custom cost item already existed

provider

string

required

model

string

required

aliases

string[]

required

input_per_m_tokens

string

required

output_per_m_tokens

string

required

cached_input_per_m_tokens

string

required

cache_write_per_m_tokens

string

required

dimensions

object[]

required

Show child attributes

effective_from

string

required

source

string

required

custom_item_id

string | null

required

override

object | null

required

Show child attributes

⌘I