Skip to content

docs: programmatic access — API keys, Use the API, and transiliencectl (CLI)#3

Open
rkreddyp wants to merge 2 commits into
mainfrom
docs/api-keys
Open

docs: programmatic access — API keys, Use the API, and transiliencectl (CLI)#3
rkreddyp wants to merge 2 commits into
mainfrom
docs/api-keys

Conversation

@rkreddyp

Copy link
Copy Markdown
Contributor

Adds user-facing documentation for programmatic API access (driving the platform from a script or an AI agent like Claude Code).

New pages

  • concepts/api-keys.md — what an API key is, where to find it (Settings → API Keys), org binding, the shown-once secret, and revocation. Includes a screenshot of the API Keys tab.
  • workflows/use-the-api.md — authenticate with Authorization: Bearer <key> (no org header — the key is org-bound) and the core loop with curl examples (list apps → run → poll → fetch files), plus how to point an AI agent at /llms.txt.

Updates

  • README router: new entries under Concepts and Workflows.
  • glossary: API, API key, llms.txt.
  • First image asset in the repo (images/api-keys-profile-ui.jpg) — a deliberate addition for the developer guide.

Matches the house style (conversational, second-person, "What it is / Where to find it / Common questions / Related"). Pairs with the mcs feature PR transilienceai/mcs#186.

rkreddyp and others added 2 commits May 28, 2026 20:26
Document programmatic access to the platform via API keys:
- concepts/api-keys.md — what keys are, where to find them, org binding,
  the shown-once secret, and revocation (with the API Keys UI screenshot).
- workflows/use-the-api.md — authenticate with a bearer key and the core
  loop (list apps → run → poll → fetch files) with curl examples; how to
  point an AI agent at /llms.txt.
- README router + glossary entries (API, API key, llms.txt).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Companion to the API docs: a command-line tool that drives the platform with an
API key.
- concepts/cli.md — what transiliencectl is, install, config, command list.
- workflows/use-the-cli.md — install → config → the agent loop (projects list →
  run --follow → files get), config reference, troubleshooting.
- README router + glossary (transiliencectl); cross-links from the API key pages.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@rkreddyp rkreddyp changed the title docs: API keys + Use the API guide docs: programmatic access — API keys, Use the API, and transiliencectl (CLI) May 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant