account

Get the account

The workspace, its plan and limits (seats, words allowed), the credential making the call with its scopes, and what Lookio offers: the query modes with their credit prices, the file formats it reads and whether this credential can keep conversations. Call this first: one request tells you what you may do.

GET/v1/account

Request

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.lookio.app/v1/account");
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/account", 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/account"))
    .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/account")
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": {
    "workspace": {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "plan": "<string>"
    },
    "credit_balance": 123,
    "entitlements": {
      "seats": 123,
      "word_allowance": 123,
      "assistants": 123,
      "widgets": 123,
      "pages_per_month": 123
    },
    "credential": {
      "id": "<string>",
      "kind": "api_key",
      "name": null,
      "prefix": "<string>",
      "scopes": [
        "account:read"
      ],
      "created_at": "<string>",
      "expires_at": null
    },
    "capabilities": {
      "query_modes": [
        {
          "id": "eco",
          "label": "<string>",
          "credits": 123,
          "description": "<string>",
          "available": true
        }
      ],
      "default_query_mode": "eco",
      "supported_formats": [
        {
          "id": "<string>",
          "label": "<string>",
          "extensions": [
            "<string>"
          ],
          "max_bytes": 123
        }
      ],
      "conversations": true,
      "webhooks": true
    }
  },
  "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.

Call this endpoint first. It verifies the credential and tells you, before you build anything on it, which workspace it belongs to, the plan and its limits, the scopes the credential holds, and what Lookio offers: the query modes with their credit prices and the file formats it reads. It also says whether this credential’s answers are kept in conversations it can continue.

An API key and a personal connection answer differently: a connection is narrowed by its owner’s permissions, and an API key never holds the admin scope, and keeps its own conversations rather than a person’s chats. See Authentication.

Authorizations

Authorizationbearerin headerrequired

Response

application/json

Retrieve the authenticated workspace

dataobjectrequired

Show child attributes

data.workspaceobjectrequired

Show child attributes

data.workspace.idstringrequired

data.workspace.namestringrequired

data.workspace.slugstringrequired

data.workspace.planstringrequired

data.credit_balanceintegerrequired

data.entitlementsobjectrequired

Show child attributes

data.entitlements.seatsinteger | nullrequired

Members the plan allows. Null is unlimited.

data.entitlements.word_allowanceinteger | nullrequired

Words the workspace may keep indexed on its plan. Null is unlimited. GET /v1/usage says how many are stored.

data.entitlements.assistantsinteger | nullrequired

Assistants the plan allows. Null is unlimited. Creating one more is refused with feature_not_available.

data.entitlements.widgetsinteger | nullrequired

Widgets the plan allows. Null is unlimited. Creating one more is refused with feature_not_available.

data.entitlements.pages_per_monthinteger | nullrequired

Pages read a month (file pages and web pages, new or changed only). Null is unlimited. GET /v1/usage says how many are used.

data.credentialobjectrequired

Show child attributes

data.credential.idstringrequired

data.credential.kindenum<string>requiredone of: api_key, oauth

data.credential.namestringnullrequired

data.credential.prefixstringrequired

data.credential.scopesenum<string>[]required

data.credential.created_atstringrequired

data.credential.expires_atstringnullrequired

data.capabilitiesobjectrequired

Show child attributes

data.capabilities.query_modesobject[]required

Show child attributes

data.capabilities.query_modes.idenum<string>requiredone of: eco, flash, deep

data.capabilities.query_modes.labelstringrequired

data.capabilities.query_modes.creditsintegerrequired

Credits a question costs in this mode, whatever the answer and its length.

data.capabilities.query_modes.descriptionstringrequired

data.capabilities.query_modes.availablebooleanrequired

data.capabilities.default_query_modeenum<string>requiredone of: eco, flash, deep

data.capabilities.supported_formatsobject[]required

Show child attributes

data.capabilities.supported_formats.idstringrequired

data.capabilities.supported_formats.labelstringrequired

data.capabilities.supported_formats.extensionsstring[]required

data.capabilities.supported_formats.max_bytesintegerrequired

The largest file of this family, in bytes.

data.capabilities.conversationsbooleanrequired

True when this credential's answers are kept in conversations it can continue with conversation_id: a person's chats, and an API key's conversations (unless a question sends store: false).

data.capabilities.webhooksbooleanrequired

request_idstringrequired

Get the account

Authorizations

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown