Candid BeaconSign in

The integration file

One plain-text document describing the entire public surface, at a stable URL. Hand it to a developer, or paste it to an AI assistant, and they have everything they need in a single fetch.

The URL

Integration guide
https://candidbeacon.com/llms.txt

It is served as text/plain. No JavaScript is needed to read it, no authentication, no navigation - it is one document and it is complete.

Open it in a new tab if you would rather read it first.

What to do with it

  • Send the URL to whoever builds your site. It carries the badge snippet, the Beacon URL, the share card and the date rules. They will not need to ask you anything else.
  • Or give it to an AI assistant along with “add my availability badge to my site”. That is the case it was written for: one fetch, no account, no key, and nothing to interpret.

Most people will never need it. If you just want the badge on your own site, the snippet is on Embed the availability badge, and it is also waiting to be copied in Work setup.

What is in it

  • The embed snippet, ready to paste, with its dimensions explained.
  • The public Beacon URL.
  • The share card URL.
  • The date rules - including the one about not converting dates into the reader’s timezone, which is the mistake an automated integration is most likely to make.
  • A plain statement of what does not exist: no write API, no way to read a freelancer’s jobs or contacts, no endpoint that takes a credential.

Nothing owner-facing is described in it, and nothing in it needs an account. Replace YOUR_USERNAME with the freelancer’s username throughout.

How it is kept true

A file meant to be read by a machine is the worst possible place for a stale value: a wrong number here is copied into somebody’s website by something that has no way to notice.

So the numbers in it are not chosen here. They are read from the app’s own source, and a test fails when the two disagree - including failing outright rather than passing quietly if it cannot check at all. That guard now covers the badge documentation page as well, which describes the same surface for people: both documents are built from one mirrored copy, so there is no third version to go out of date.

The prose on these pages is a different matter. It was read from the app and verified before it was written, but it is not machine-compared - which is worth knowing if you are relying on a sentence rather than a number.