Get the caller's real per-tool credit usage aggregation

GET

api

credits

usage-summary

curl --request GET \
  --url https://api.vyomflow.co.in/api/v1/me/credits/usage-summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vyomflow.co.in/api/v1/me/credits/usage-summary', 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.vyomflow.co.in/api/v1/me/credits/usage-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.vyomflow.co.in/api/v1/me/credits/usage-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vyomflow.co.in/api/v1/me/credits/usage-summary")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "groups": [
    {
      "toolKey": "<string>",
      "displayName": "<string>",
      "totalDebited": "<string>",
      "records": 1,
      "latestUsageAt": "<string>"
    }
  ],
  "totalDebitedAll": "<string>",
  "recordsAll": 1,
  "categoriesCount": 1,
  "periodStart": "<string>",
  "periodEnd": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

Authorization

string

header

required

Clerk session token, Authorization: Bearer <token> — the first-party browser app's own auth. Used only by this internal /api/v1/* surface, never by /api/public/v1/*.

Response

Per-tool usage groups plus overall totals.

groups

object[]

required

Show child attributes

totalDebitedAll

string

required

recordsAll

integer

required

Required range: x >= 0

categoriesCount

integer

required

Required range: x >= 0

periodStart

string | null

required

periodEnd

string | null

required

⌘I

Get the caller's real per-tool credit usage aggregation

curl --request GET \
  --url https://api.vyomflow.co.in/api/v1/me/credits/usage-summary \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.vyomflow.co.in/api/v1/me/credits/usage-summary', 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.vyomflow.co.in/api/v1/me/credits/usage-summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.vyomflow.co.in/api/v1/me/credits/usage-summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.vyomflow.co.in/api/v1/me/credits/usage-summary")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "groups": [
    {
      "toolKey": "<string>",
      "displayName": "<string>",
      "totalDebited": "<string>",
      "records": 1,
      "latestUsageAt": "<string>"
    }
  ],
  "totalDebitedAll": "<string>",
  "recordsAll": 1,
  "categoriesCount": 1,
  "periodStart": "<string>",
  "periodEnd": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Overview

Endpoints

Get the caller's real per-tool credit usage aggregation

Authorizations

Response