import { OctosparkClient } from '@octospark/sdk'
const client = new OctosparkClient({
token: process.env.OCTOSPARK_TOKEN
})
const response = await client.billing.createTopUpSession({
organizationId: process.env.OCTOSPARK_ORGANIZATION_ID ?? "organizationId",
body: {},
})import os
from octospark_sdk import OctosparkClient
client = OctosparkClient(token=os.environ["OCTOSPARK_TOKEN"])
response = client.billing.create_top_up_session(
organizationId=os.environ.get("OCTOSPARK_ORGANIZATION_ID", "organizationId"),
body={}
)octospark billing topup \
--request '{"path":{"organizationId":"organizationId"},"body":{}}'use reqwest::Client;
use std::env;
#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
let client = Client::new();
let base_url = env::var("OCTOSPARK_API_URL").unwrap_or_else(|_| "https://api.octospark.ai".to_string());
let organization_id = env::var("OCTOSPARK_ORGANIZATION_ID").unwrap_or_else(|_| "organizationId".to_string());
let url = format!("{}/v1/billing/{}/top-up", base_url.trim_end_matches('/'), organization_id);
let token = env::var("OCTOSPARK_TOKEN").expect("OCTOSPARK_TOKEN");
let mut request = client.post(url).bearer_auth(token);
request = request.json(&serde_json::json!({}));
let response = request.send().await?;
println!("{}", response.text().await?);
Ok(())
}import 'dart:convert';
import 'dart:io';
import 'package:http/http.dart' as http;
Future<void> main() async {
final baseUrl = Platform.environment['OCTOSPARK_API_URL'] ?? 'https://api.octospark.ai';
final token = Platform.environment['OCTOSPARK_TOKEN'];
final organizationId = Platform.environment['OCTOSPARK_ORGANIZATION_ID'] ?? 'organizationId';
final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/$organizationId/top-up';
final uri = Uri.parse(url);
final headers = {
'Authorization': 'Bearer $token',
'Content-Type': 'application/json',
};
final response = await http.post(
uri,
headers: headers,
body: jsonEncode({}),
);
print(response.body);
}curl --request POST \
--url https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amountDecimillicents": 200000000,
"successUrl": "https://app.octospark.ai/billing?topup=success",
"cancelUrl": "https://app.octospark.ai/billing?topup=cancelled"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up",
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([
'amountDecimillicents' => 200000000,
'successUrl' => 'https://app.octospark.ai/billing?topup=success',
'cancelUrl' => 'https://app.octospark.ai/billing?topup=cancelled'
]),
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-staging.octospark.ai/v1/billing/{organizationId}/top-up"
payload := strings.NewReader("{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\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-staging.octospark.ai/v1/billing/{organizationId}/top-up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up")
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 \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}"
response = http.request(request)
puts response.read_body$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"amountDecimillicents": 200000000,
"successUrl": "https://app.octospark.ai/billing?topup=success",
"cancelUrl": "https://app.octospark.ai/billing?topup=cancelled"
}'import Foundation
let parameters = [
"amountDecimillicents": 200000000,
"successUrl": "https://app.octospark.ai/billing?topup=success",
"cancelUrl": "https://app.octospark.ai/billing?topup=cancelled"
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))using RestSharp;
var options = new RestClientOptions("https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}");
CURLcode ret = curl_easy_perform(hnd);CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}");
CURLcode ret = curl_easy_perform(hnd);val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}")
val request = Request.Builder()
.url("https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up")
.post(body)
.addHeader("Authorization", "Bearer <token>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute(){
"id": "<string>",
"url": "<string>"
}{
"issues": [
{
"_tag": "Pointer",
"path": [
"<string>"
],
"message": "<string>"
}
],
"message": "<string>",
"_tag": "HttpApiDecodeError"
}{
"message": "<string>",
"_tag": "Unauthorized"
}{
"message": "<string>",
"_tag": "PaymentRequired"
}{
"message": "<string>",
"_tag": "Forbidden"
}{
"message": "<string>",
"_tag": "NotFound"
}{
"message": "<string>",
"_tag": "Conflict",
"code": "<string>",
"currentRevision": 123
}{
"message": "<string>",
"code": "<string>",
"_tag": "UnprocessableEntity"
}{
"message": "<string>",
"_tag": "TooManyRequests",
"code": "<string>",
"retryAfterSeconds": 123
}{
"message": "<string>",
"_tag": "InternalError"
}Create top up session
Create a Stripe checkout session for a one-off credit top-up and return the session URL for a human to complete payment in a browser. No charge happens on this call; credits are granted only after Stripe confirms payment. Check getCreditBalance first to see whether a top-up is actually needed.
import { OctosparkClient } from '@octospark/sdk'
const client = new OctosparkClient({
token: process.env.OCTOSPARK_TOKEN
})
const response = await client.billing.createTopUpSession({
organizationId: process.env.OCTOSPARK_ORGANIZATION_ID ?? "organizationId",
body: {},
})import os
from octospark_sdk import OctosparkClient
client = OctosparkClient(token=os.environ["OCTOSPARK_TOKEN"])
response = client.billing.create_top_up_session(
organizationId=os.environ.get("OCTOSPARK_ORGANIZATION_ID", "organizationId"),
body={}
)octospark billing topup \
--request '{"path":{"organizationId":"organizationId"},"body":{}}'use reqwest::Client;
use std::env;
#[tokio::main]
async fn main() -> Result<(), reqwest::Error> {
let client = Client::new();
let base_url = env::var("OCTOSPARK_API_URL").unwrap_or_else(|_| "https://api.octospark.ai".to_string());
let organization_id = env::var("OCTOSPARK_ORGANIZATION_ID").unwrap_or_else(|_| "organizationId".to_string());
let url = format!("{}/v1/billing/{}/top-up", base_url.trim_end_matches('/'), organization_id);
let token = env::var("OCTOSPARK_TOKEN").expect("OCTOSPARK_TOKEN");
let mut request = client.post(url).bearer_auth(token);
request = request.json(&serde_json::json!({}));
let response = request.send().await?;
println!("{}", response.text().await?);
Ok(())
}import 'dart:convert';
import 'dart:io';
import 'package:http/http.dart' as http;
Future<void> main() async {
final baseUrl = Platform.environment['OCTOSPARK_API_URL'] ?? 'https://api.octospark.ai';
final token = Platform.environment['OCTOSPARK_TOKEN'];
final organizationId = Platform.environment['OCTOSPARK_ORGANIZATION_ID'] ?? 'organizationId';
final url = '${baseUrl.replaceFirst(RegExp(r'/$'), '')}/v1/billing/$organizationId/top-up';
final uri = Uri.parse(url);
final headers = {
'Authorization': 'Bearer $token',
'Content-Type': 'application/json',
};
final response = await http.post(
uri,
headers: headers,
body: jsonEncode({}),
);
print(response.body);
}curl --request POST \
--url https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amountDecimillicents": 200000000,
"successUrl": "https://app.octospark.ai/billing?topup=success",
"cancelUrl": "https://app.octospark.ai/billing?topup=cancelled"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up",
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([
'amountDecimillicents' => 200000000,
'successUrl' => 'https://app.octospark.ai/billing?topup=success',
'cancelUrl' => 'https://app.octospark.ai/billing?topup=cancelled'
]),
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-staging.octospark.ai/v1/billing/{organizationId}/top-up"
payload := strings.NewReader("{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\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-staging.octospark.ai/v1/billing/{organizationId}/top-up")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up")
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 \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}"
response = http.request(request)
puts response.read_body$headers=@{}
$headers.Add("Authorization", "Bearer <token>")
$headers.Add("Content-Type", "application/json")
$response = Invoke-WebRequest -Uri 'https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
"amountDecimillicents": 200000000,
"successUrl": "https://app.octospark.ai/billing?topup=success",
"cancelUrl": "https://app.octospark.ai/billing?topup=cancelled"
}'import Foundation
let parameters = [
"amountDecimillicents": 200000000,
"successUrl": "https://app.octospark.ai/billing?topup=success",
"cancelUrl": "https://app.octospark.ai/billing?topup=cancelled"
] as [String : Any?]
let postData = try JSONSerialization.data(withJSONObject: parameters, options: [])
let url = URL(string: "https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
]
request.httpBody = postData
let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))using RestSharp;
var options = new RestClientOptions("https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
using RestSharp;
var options = new RestClientOptions("https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}");
CURLcode ret = curl_easy_perform(hnd);CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}");
CURLcode ret = curl_easy_perform(hnd);val client = OkHttpClient()
val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{\n \"amountDecimillicents\": 200000000,\n \"successUrl\": \"https://app.octospark.ai/billing?topup=success\",\n \"cancelUrl\": \"https://app.octospark.ai/billing?topup=cancelled\"\n}")
val request = Request.Builder()
.url("https://api-staging.octospark.ai/v1/billing/{organizationId}/top-up")
.post(body)
.addHeader("Authorization", "Bearer <token>")
.addHeader("Content-Type", "application/json")
.build()
val response = client.newCall(request).execute(){
"id": "<string>",
"url": "<string>"
}{
"issues": [
{
"_tag": "Pointer",
"path": [
"<string>"
],
"message": "<string>"
}
],
"message": "<string>",
"_tag": "HttpApiDecodeError"
}{
"message": "<string>",
"_tag": "Unauthorized"
}{
"message": "<string>",
"_tag": "PaymentRequired"
}{
"message": "<string>",
"_tag": "Forbidden"
}{
"message": "<string>",
"_tag": "NotFound"
}{
"message": "<string>",
"_tag": "Conflict",
"code": "<string>",
"currentRevision": 123
}{
"message": "<string>",
"code": "<string>",
"_tag": "UnprocessableEntity"
}{
"message": "<string>",
"_tag": "TooManyRequests",
"code": "<string>",
"retryAfterSeconds": 123
}{
"message": "<string>",
"_tag": "InternalError"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Organization id (UUID). Discover ids via the list organizations endpoint or the agent context.
Body
One-time credit purchase amount in decimillicents (10000000 decimillicents = $1, so 100000 = 1 cent); min 5000000 ($0.50, the Stripe minimum charge), max 5000000000 ($500).
5000000 <= x <= 5000000000200000000
http(s) URL Stripe redirects the user to after a successful checkout.
^https?:\/\/"https://app.octospark.ai/billing?topup=success"
http(s) URL Stripe redirects the user to when they abandon the checkout.
^https?:\/\/"https://app.octospark.ai/billing?topup=cancelled"