accesses

Retrieve an access

One access with its assistants, capabilities, ceilings, this month's spending and its keys (never their secrets).

GET/v1/accesses/{access_id}

Request

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

import json
import requests

url = "https://api.lookio.app/v1/accesses/<access_id>"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://api.lookio.app/v1/accesses/<access_id>", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.lookio.app/v1/accesses/<access_id>");
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/accesses/<access_id>", 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/accesses/<access_id>"))
    .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/accesses/<access_id>")
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": {
    "id": "acc_k7m3x9p2w8qr",
    "name": "Acme docs",
    "description": "Acme's product documentation, changelog and support answers.",
    "protection": "keys",
    "status": "live",
    "capabilities": {
      "modes": [
        "flash",
        "deep"
      ],
      "passages": true
    },
    "daily_credits": null,
    "monthly_credits": 200000,
    "assistants": [
      {
        "id": "ast_66xcnwtzj8vt",
        "name": "Acme docs",
        "description": "Answers from the product documentation and the changelog.",
        "reads_nothing": false
      }
    ],
    "key_count": 2,
    "stats": {
      "today_credits": 120,
      "month_credits": 5400,
      "month_requests": 180
    },
    "blocked": null,
    "urls": {
      "help": "https://api.lookio.app/a/acc_k7m3x9p2w8qr",
      "mcp": "https://mcp.lookio.app/a/acc_k7m3x9p2w8qr/mcp",
      "assistants": "https://api.lookio.app/a/acc_k7m3x9p2w8qr/assistants",
      "ask": "https://api.lookio.app/a/acc_k7m3x9p2w8qr/ask",
      "search": "https://api.lookio.app/a/acc_k7m3x9p2w8qr/search"
    },
    "created_at": "2026-10-29T10:00:00.000Z",
    "updated_at": "2026-10-29T10:00:00.000Z",
    "keys": [
      {
        "id": "aky_h4n8c2v6y9tk",
        "name": "Globex",
        "prefix": "ak_live_k7f2p9x4m1c8",
        "daily_credits": 3000,
        "monthly_credits": null,
        "spent": {
          "today": 60,
          "month": 1800
        },
        "last_used_at": "2026-10-29T10:00:00.000Z",
        "created_at": "2026-10-20T10:00:00.000Z"
      }
    ]
  },
  "request_id": "req_01K9X7M2Q4"
}

{
  "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>"
}

Authorizations

Authorizationbearerin headerrequired

Path parameters

access_idstringrequired

Response

application/json

Retrieve an access

dataobjectrequired

Show child attributes

data.idstringrequiredpattern: ^acc_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

data.namestringrequired

data.descriptionstringrequired

What callers read about the access as a whole.

data.protectionenum<string>requiredone of: public, keys

public: anyone with the address may call it. keys: every call needs one of its access keys (Pro plan).

data.statusenum<string>requiredone of: live, paused

data.capabilitiesobjectrequired

Show child attributes

data.capabilities.modesenum<string>[]required

The query modes callers may ask in, at their usual prices. Empty turns answers off.

data.capabilities.passagesbooleanrequired

Whether callers may search the passages without an answer (1 credit a search).

data.daily_creditsinteger | nullrequired

Credits the whole access, per UTC day, may spend; null is no ceiling. A call whose price does not fit is refused with rate_limited until the window resets.

data.monthly_creditsinteger | nullrequired

Credits the whole access, per UTC month, may spend; null is no ceiling. A call whose price does not fit is refused with rate_limited until the window resets.

data.assistantsobject[]required

Show child attributes

data.assistants.idstringrequiredpattern: ^ast_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

data.assistants.namestringrequired

data.assistants.descriptionstringrequired

What callers read about it. Its context, guidelines and resources are never shown to them.

data.assistants.reads_nothingbooleanrequired

It reads no searchable resource, so callers asking it are refused (for free).

data.key_countintegerrequired

data.statsobjectrequired

Show child attributes

data.stats.today_creditsintegerrequired

data.stats.month_creditsintegerrequired

data.stats.month_requestsintegerrequired

data.blockedenum<string> | nullrequired

Why it does not answer, when it does not: paused; keys_need_plan (protected, and the plan has no keys); no_keys (protected, no key yet); no_assistants (none of its assistants reads anything). Null: it answers.

data.urlsobjectrequired

Show child attributes

data.urls.helpstringrequired

Its help, for people and agents: what it holds and how to call it (GET).

data.urls.mcpstringrequired

Its MCP server (Streamable HTTP).

data.urls.assistantsstringrequired

data.urls.askstringrequired

data.urls.searchstringrequired

data.keysobject[]

Its access keys, on a single access (not in the list).

Show child attributes

data.keys.idstringrequiredpattern: ^aky_[abcdefghjkmnpqrstuvwxyz23456789]{12}$

data.keys.namestringrequired

Who the key is for.

data.keys.prefixstringrequired

The start of the key (ak_live_<key id>), to recognise it. The whole key is shown once, at creation.

data.keys.daily_creditsinteger | nullrequired

data.keys.monthly_creditsinteger | nullrequired

data.keys.spentobjectrequired

Credits spent with this key, this UTC day and month.

Show child attributes

data.keys.spent.todayintegerrequired

data.keys.spent.monthintegerrequired

data.keys.last_used_atstringnullrequired

data.keys.created_atstringrequired

data.created_atstringrequired

data.updated_atstringrequired

request_idstringrequired

{ "data": { "id": "acc_k7m3x9p2w8qr", "name": "Acme docs", "description": "Acme's product documentation, changelog and support answers.", "protection": "keys", "status": "live", "capabilities": { "modes": [ "flash", "deep" ], "passages": true }, "daily_credits": null, "monthly_credits": 200000, "assistants": [ { "id": "ast_66xcnwtzj8vt", "name": "Acme docs", "description": "Answers from the product documentation and the changelog.", "reads_nothing": false } ], "key_count": 2, "stats": { "today_credits": 120, "month_credits": 5400, "month_requests": 180 }, "blocked": null, "urls": { "help": "https://api.lookio.app/a/acc_k7m3x9p2w8qr", "mcp": "https://mcp.lookio.app/a/acc_k7m3x9p2w8qr/mcp", "assistants": "https://api.lookio.app/a/acc_k7m3x9p2w8qr/assistants", "ask": "https://api.lookio.app/a/acc_k7m3x9p2w8qr/ask", "search": "https://api.lookio.app/a/acc_k7m3x9p2w8qr/search" }, "created_at": "2026-10-29T10:00:00.000Z", "updated_at": "2026-10-29T10:00:00.000Z", "keys": [ { "id": "aky_h4n8c2v6y9tk", "name": "Globex", "prefix": "ak_live_k7f2p9x4m1c8", "daily_credits": 3000, "monthly_credits": null, "spent": { "today": 60, "month": 1800 }, "last_used_at": "2026-10-29T10:00:00.000Z", "created_at": "2026-10-20T10:00:00.000Z" } ] }, "request_id": "req_01K9X7M2Q4" }

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

Retrieve an access

Authorizations

Path parameters

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown