Skip to content

Add API key creation instructions to README#13

Merged
amavashev merged 1 commit into
mainfrom
claude/clarify-api-key-docs-L5wR1
Mar 17, 2026
Merged

Add API key creation instructions to README#13
amavashev merged 1 commit into
mainfrom
claude/clarify-api-key-docs-L5wR1

Conversation

@amavashev
Copy link
Copy Markdown
Contributor

Summary

Added documentation to the README explaining how to create and manage API keys for the Cycles platform.

Key Changes

  • Added a detailed "Need an API key?" section after the basic usage example with:
    • Reference to the deployment guide
    • Complete curl command example for creating API keys via the Cycles Admin Server (port 7979)
    • Instructions on how to extract and save the generated key
    • Link to API Key Management documentation for rotation and lifecycle details
  • Added a brief reference note in the configuration section pointing users to API key creation resources

Details

The new documentation provides users with:

  1. A complete, copy-paste ready curl command to create API keys through the Admin Server
  2. Clear warning that the key is shown only once and must be saved immediately
  3. Links to both the deployment guide and API key management documentation for additional context
  4. Placement in two logical locations: after the basic usage example and in the configuration section

https://claude.ai/code/session_01HftF1nebzvUzQy4y4zGJk6

Add a blockquote note after the Quick Start section explaining how to
create an API key via the Admin Server, with the curl command and link
to the deployment guide. Add a shorter note in the Configuration section.

https://claude.ai/code/session_01HftF1nebzvUzQy4y4zGJk6
@amavashev amavashev merged commit 93c8fae into main Mar 17, 2026
2 checks passed
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.

2 participants