credits

Get the credit balance

The current balance plus each grant with its remaining amount and expiry. next_refill_estimated_at is derived from the latest monthly grant's expiry and is an estimate, not a guarantee: the refill runs on a cron pass after that moment.

GET/v1/credits

Request

curl --request GET \
  --url 'https://api.lookio.app/v1/credits' \
  --header 'Authorization: <api-key>'

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.lookio.app/v1/credits");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("GET", "https://api.lookio.app/v1/credits", nil)
  req.Header.Set("Authorization", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.lookio.app/v1/credits"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.lookio.app/v1/credits")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "balance": 123,
    "plan": "<string>",
    "monthly_allowance": 123,
    "next_refill_estimated_at": null,
    "grants": [
      {
        "id": "<string>",
        "type": "<string>",
        "amount": 123,
        "used": 123,
        "remaining": 123,
        "granted_at": null,
        "expires_at": null
      }
    ]
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

{
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "docs_url": "<string>",
    "action_url": "<string>"
  },
  "request_id": "<string>"
}

Requires account:read.

Reading credits costs nothing. Credits are spent only when an assistant answers a question.

The estimated date of the next refill is an estimate, derived from the expiry of the latest monthly grant. It is not a guarantee. See Credits and plans.

Authorizations

Authorizationbearerin headerrequired

Response

application/json

Retrieve the credit balance and every grant

dataobjectrequired

Show child attributes

data.balanceintegerrequired

data.planstringrequired

data.monthly_allowanceinteger | nullrequired

data.next_refill_estimated_atstringnullrequired

data.grantsobject[]required

Show child attributes

data.grants.idstringrequired

data.grants.typestringrequired

data.grants.amountintegerrequired

data.grants.usedintegerrequired

data.grants.remainingintegerrequired

data.grants.granted_atstringnullrequired

data.grants.expires_atstringnullrequired

request_idstringrequired

{ "data": { "balance": 123, "plan": "<string>", "monthly_allowance": 123, "next_refill_estimated_at": null, "grants": [ { "id": "<string>", "type": "<string>", "amount": 123, "used": 123, "remaining": 123, "granted_at": null, "expires_at": null } ] }, "request_id": "<string>" }

{ "error": { "type": "<string>", "code": "<string>", "message": "<string>", "param": "<string>", "docs_url": "<string>", "action_url": "<string>" }, "request_id": "<string>" }

Get the credit balance

Authorizations

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown