List the fleet | Context Link

llm prompts Alert before the next bundle Sync my fleet dashboard

The whole fleet

The API behind the fleet screen:

Response fields

api_accountsarray

One summary row per api_account on this page, oldest first.

api_accounts[].idinteger

Context Link's own id for the account.

api_accounts[].uidstring

The customer id you provisioned the account with.

api_accounts[].labelstring

The account's display name, falling back to the uid.

api_accounts[].site_urlstring

The website being crawled, null for an account with no website.

api_accounts[].sync_statusstring

The crawl state: unsynced, syncing, synced, error_syncing, or no_site for an account with no website.

api_accounts[].index_readyboolean

Whether the account's website has completed a successful crawl.

api_accounts[].postsinteger

Documents indexed across every connection the account owns.

api_accounts[].chunksinteger

Embedded passages indexed across every connection the account owns.

usageobject

Organisation-wide totals, independent of the page of accounts returned.

usage.api_users_countinteger

api_accounts currently provisioned across your whole organisation.

usage.api_users_allowanceinteger

Total api_account slots your subscription covers, which is 10 per bundle.

usage.bundlesinteger

Bundles currently on your subscription, or 0 when the organisation is off the white-label plan.

usage.slots_availableinteger

Slots left before the next bundle is auto-added on overflow.

paginationobject

Paging state for the api_accounts array.

pagination.pageinteger

The page returned, starting at 1.

pagination.per_pageinteger

Rows per page, capped at 100.

pagination.totalinteger

api_accounts matching the request across every page.

pagination.total_pagesinteger

Pages available at this per_page.

per_page is capped at 100.

Each row is a summary. For one account's full status, its index readiness and the paragraph describing who that customer is, see GET /api_accounts/:uid.

curl "https://context-link.ai/api/v1/api_accounts?page=1&per_page=25" \
  -H "Authorization: Bearer $PROVISIONING_TOKEN"

require "net/http"

uri = URI("https://context-link.ai/api/v1/api_accounts")
uri.query = URI.encode_www_form("page" => "1", "per_page" => "25")

request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("PROVISIONING_TOKEN")}"

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

puts response.body

import os
import requests

url = "https://context-link.ai/api/v1/api_accounts"
params = {"page": "1", "per_page": "25"}

headers = {
    "Authorization": f"Bearer {os.environ['PROVISIONING_TOKEN']}",
}

response = requests.get(url, headers=headers, params=params, timeout=30)
print(response.text)

// Runs on your server only: the token must never reach the browser.
const url = new URL("https://context-link.ai/api/v1/api_accounts");
url.searchParams.set("page", "1");
url.searchParams.set("per_page", "25");

const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${process.env.PROVISIONING_TOKEN}`,
  },
});

console.log(await response.text());

// Runs on your server only: the token must never reach the browser.
async function main() {
  const url = new URL("https://context-link.ai/api/v1/api_accounts");
  url.searchParams.set("page", "1");
  url.searchParams.set("per_page", "25");

  const response = await fetch(url, {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${process.env.PROVISIONING_TOKEN}`,
    },
  });

  console.log(await response.text());
}

main();

Response

{
  "api_accounts": [
    { "id": 4211, "uid": "tf-cust-8841", "label": "Acme Supply Co", "site_url": "https://acme.com",
      "sync_status": "synced", "index_ready": true, "posts": 214, "chunks": 1893 }
  ],
  "usage": {
    "api_users_count": 11,
    "api_users_allowance": 20,
    "bundles": 2,
    "slots_available": 9
  },
  "pagination": { "page": 1, "per_page": 25, "total": 11, "total_pages": 1 }
}

← Back to Docs Raw markdown guide for AI