usage

Get usage over time

What the workspace's answers cost over a range, from the ledger of settled answers: answers and credits per day, week or month, and broken down by query mode, assistant, who asked (a person or an API key) and API key, plus the words stored and the pages extracted this month against the plan's allowances. With no parameters it returns the last 30 days. Granularity defaults to the range length: day up to 31 days, week up to 180, month beyond.

GET/v1/usage

Request

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.lookio.app/v1/usage");
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/usage", 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/usage"))
    .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/usage")
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": {
    "from": "<string>",
    "to": "<string>",
    "granularity": "day",
    "totals": {
      "answers": 123,
      "credits_used": 123
    },
    "points": [
      {
        "date": "<string>",
        "answers": 123,
        "credits_used": 123
      }
    ],
    "by_mode": [
      {
        "mode": "<string>",
        "answers": 123,
        "credits_used": 123
      }
    ],
    "by_assistant": [
      {
        "assistant_id": null,
        "name": null,
        "answers": 123,
        "credits_used": 123
      }
    ],
    "by_origin": [
      {
        "origin": "person",
        "answers": 123,
        "credits_used": 123
      }
    ],
    "by_api_key": [
      {
        "credential_id": "<string>",
        "name": null,
        "answers": 123,
        "credits_used": 123
      }
    ],
    "words": {
      "stored": 123,
      "allowance": 123
    },
    "pages": {
      "used": 123,
      "allowance": 123,
      "resets_at": "<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>"
}

{
  "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 usage:read.

Usage comes from the ledger of settled answers, so it counts what was charged, not what was reserved. Besides the totals and one point per bucket, it breaks the usage down by query mode, by assistant, by who asked (a person or an API key) and by API key, and reports the words stored against your plan’s allowance.

Without parameters, the range is the last 30 days. When you omit granularity, it follows the length of the range: day up to 31 days, week up to 180, month beyond. from and to accept a date such as 2026-07-01 or a full ISO 8601 timestamp, and a date-only to means the end of that day.

Answers given through a widget are part of these figures.

Authorizations

Authorizationbearerin headerrequired

Query parameters

fromstring

tostring

granularityenum<string>one of: day, week, month

Response

application/json

Retrieve credit usage over time

dataobjectrequired

Show child attributes

data.fromstringrequired

data.tostringrequired

data.granularityenum<string>requiredone of: day, week, month

data.totalsobjectrequired

Show child attributes

data.totals.answersintegerrequired

Answers settled, found or not.

data.totals.credits_usedintegerrequired

data.pointsobject[]required

Show child attributes

data.points.datestringrequired

data.points.answersintegerrequired

Answers settled, found or not.

data.points.credits_usedintegerrequired

data.by_modeobject[]required

Per query mode. Besides the modes of GET /v1/account, it can list search (passage searches) and modes no longer offered, such as europe and agent-lite, kept for the history.

Show child attributes

data.by_mode.modestringrequired

data.by_mode.answersintegerrequired

Answers settled, found or not.

data.by_mode.credits_usedintegerrequired

data.by_assistantobject[]required

Show child attributes

data.by_assistant.assistant_idstringnullrequired

data.by_assistant.namestringnullrequired

Null when the assistant was deleted since.

data.by_assistant.answersintegerrequired

Answers settled, found or not.

data.by_assistant.credits_usedintegerrequired

data.by_originobject[]required

Show child attributes

data.by_origin.originenum<string>requiredone of: person, api_key

person: someone asking from the app, the CLI or an MCP client. api_key: a technical identity.

data.by_origin.answersintegerrequired

Answers settled, found or not.

data.by_origin.credits_usedintegerrequired

data.by_api_keyobject[]required

Show child attributes

data.by_api_key.credential_idstringrequired

data.by_api_key.namestringnullrequired

data.by_api_key.answersintegerrequired

Answers settled, found or not.

data.by_api_key.credits_usedintegerrequired

data.wordsobjectrequired

Show child attributes

data.words.storedintegerrequired

Words currently indexed in the workspace.

data.words.allowanceinteger | nullrequired

What the plan allows. Null is unlimited.

data.pagesobjectrequired

Show child attributes

data.pages.usedintegerrequired

Pages extracted this calendar month (UTC): OCR pages and web pages read, new or changed only. Imports never spend credits.

data.pages.allowanceinteger | nullrequired

Pages the plan extracts a month. Null is unlimited.

data.pages.resets_atstringrequired

When the count starts again (the first of next month, UTC).

request_idstringrequired

Get usage over time

Authorizations

Query parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown