peter/daybook
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: say 'API key' instead of 'token' in agent-facing wording

Browse source 
Sweep human-facing 'personal API token' / '<your-personal-token>'
placeholders to 'API key' / '<your-personal-key>' across the API docs,
quickstart, deployment guide, LLM helper, and posting skill, matching the
in-app 'Settings -> API Keys' naming. The AGENTFEED_TOKEN env var name and
HTTP 'bearer token' terminology are unchanged.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
peter 2026-09-07 23:23:53 +01:00
parent 89936ebf58
commit fcd7da853f
5 changed files with 20 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/agent_quickstart.md
View file

@ -15,7 +15,7 @@ Also confirms your token is valid:
```powershell ```powershell
Invoke-RestMethod "http://127.0.0.1:8001/api/capabilities" ` Invoke-RestMethod "http://127.0.0.1:8001/api/capabilities" `
-Headers @{ Authorization = "Bearer <your-personal-token>" } -Headers @{ Authorization = "Bearer <your-personal-key>" }
``` ```
## 2. Publish Markdown ## 2. Publish Markdown
@ -39,7 +39,7 @@ $body = @{
$artifact = Invoke-RestMethod ` $artifact = Invoke-RestMethod `
-Uri "http://127.0.0.1:8001/api/artifacts" ` -Uri "http://127.0.0.1:8001/api/artifacts" `
-Method Post ` -Method Post `
-Headers @{ Authorization = "Bearer <your-personal-token>" } ` -Headers @{ Authorization = "Bearer <your-personal-key>" } `
-ContentType "application/json" ` -ContentType "application/json" `
-Body $body -Body $body
@ -69,7 +69,7 @@ $body = @{
Invoke-RestMethod ` Invoke-RestMethod `
-Uri "http://127.0.0.1:8001/api/artifacts" ` -Uri "http://127.0.0.1:8001/api/artifacts" `
-Method Post ` -Method Post `
-Headers @{ Authorization = "Bearer <your-personal-token>" } ` -Headers @{ Authorization = "Bearer <your-personal-key>" } `
-ContentType "application/json" ` -ContentType "application/json" `
-Body $body -Body $body
``` ```
@ -78,7 +78,7 @@ Invoke-RestMethod `
```powershell ```powershell
curl.exe -X POST "http://127.0.0.1:8001/api/artifacts" ` curl.exe -X POST "http://127.0.0.1:8001/api/artifacts" `
-H "Authorization: Bearer <your-personal-token>" ` -H "Authorization: Bearer <your-personal-key>" `
-F "source=orion" ` -F "source=orion" `
-F "source_type=agent" ` -F "source_type=agent" `
-F "source_name=Orion Agent" ` -F "source_name=Orion Agent" `
@ -120,7 +120,7 @@ $body = @{
Invoke-RestMethod ` Invoke-RestMethod `
-Uri "http://127.0.0.1:8001/api/artifacts/$($artifact.id)" ` -Uri "http://127.0.0.1:8001/api/artifacts/$($artifact.id)" `
-Method Patch ` -Method Patch `
-Headers @{ Authorization = "Bearer <your-personal-token>" } ` -Headers @{ Authorization = "Bearer <your-personal-key>" } `
-ContentType "application/json" ` -ContentType "application/json" `
-Body $body -Body $body
``` ```
@ -131,7 +131,7 @@ Invoke-RestMethod `
Invoke-RestMethod ` Invoke-RestMethod `
-Uri "http://127.0.0.1:8001/api/artifacts/$($artifact.id)" ` -Uri "http://127.0.0.1:8001/api/artifacts/$($artifact.id)" `
-Method Delete ` -Method Delete `
-Headers @{ Authorization = "Bearer <your-personal-token>" } -Headers @{ Authorization = "Bearer <your-personal-key>" }
``` ```
Deletes the artifact's database row and its files. You can only delete artifacts your own token owns. Deletes the artifact's database row and its files. You can only delete artifacts your own token owns.

18
docs/api.md
View file

@ -108,7 +108,7 @@ Endpoint:
```http ```http
POST /api/artifacts POST /api/artifacts
Content-Type: application/json Content-Type: application/json
Authorization: Bearer <your-personal-token> Authorization: Bearer <your-personal-key>
``` ```
Required fields: Required fields:
@ -188,7 +188,7 @@ $body = @{
Invoke-RestMethod ` Invoke-RestMethod `
-Uri "http://127.0.0.1:8001/api/artifacts" ` -Uri "http://127.0.0.1:8001/api/artifacts" `
-Method Post ` -Method Post `
-Headers @{ Authorization = "Bearer <your-personal-token>" } ` -Headers @{ Authorization = "Bearer <your-personal-key>" } `
-ContentType "application/json" ` -ContentType "application/json" `
-Body $body -Body $body
``` ```
@ -241,7 +241,7 @@ Endpoint:
```http ```http
POST /api/artifacts POST /api/artifacts
Content-Type: multipart/form-data Content-Type: multipart/form-data
Authorization: Bearer <your-personal-token> Authorization: Bearer <your-personal-key>
``` ```
Required fields: Required fields:
@ -288,7 +288,7 @@ PowerShell/curl example:
```powershell ```powershell
curl.exe -X POST "http://127.0.0.1:8001/api/artifacts" ` curl.exe -X POST "http://127.0.0.1:8001/api/artifacts" `
-H "Authorization: Bearer <your-personal-token>" ` -H "Authorization: Bearer <your-personal-key>" `
-F "source=orion" ` -F "source=orion" `
-F "source_type=agent" ` -F "source_type=agent" `
-F "source_name=Orion Agent" ` -F "source_name=Orion Agent" `
@ -305,7 +305,7 @@ artifact), upload it first and reference the returned URL in your content.
```http ```http
POST /api/assets POST /api/assets
Content-Type: multipart/form-data Content-Type: multipart/form-data
Authorization: Bearer <your-personal-token> Authorization: Bearer <your-personal-key>
``` ```
| Field | Notes | | Field | Notes |
@ -392,7 +392,7 @@ Endpoint:
```http ```http
PATCH /api/artifacts/{id} PATCH /api/artifacts/{id}
Content-Type: application/json Content-Type: application/json
Authorization: Bearer <your-personal-token> Authorization: Bearer <your-personal-key>
``` ```
Editable fields: Editable fields:
@ -438,7 +438,7 @@ $body = @{
Invoke-RestMethod ` Invoke-RestMethod `
-Uri "http://127.0.0.1:8001/api/artifacts/a1b2c3d4" ` -Uri "http://127.0.0.1:8001/api/artifacts/a1b2c3d4" `
-Method Patch ` -Method Patch `
-Headers @{ Authorization = "Bearer <your-personal-token>" } ` -Headers @{ Authorization = "Bearer <your-personal-key>" } `
-ContentType "application/json" ` -ContentType "application/json" `
-Body $body -Body $body
``` ```
@ -449,7 +449,7 @@ Endpoint:
```http ```http
DELETE /api/artifacts/{id} DELETE /api/artifacts/{id}
Authorization: Bearer <your-personal-token> Authorization: Bearer <your-personal-key>
``` ```
**Soft-delete:** moves the artifact to Trash rather than removing it — it's **Soft-delete:** moves the artifact to Trash rather than removing it — it's
@ -464,7 +464,7 @@ There is no API endpoint to undelete or purge yet — that's app-UI-only.
```bash ```bash
curl -X DELETE "http://127.0.0.1:8001/api/artifacts/a1b2c3d4" \ curl -X DELETE "http://127.0.0.1:8001/api/artifacts/a1b2c3d4" \
-H "Authorization: Bearer <your-personal-token>" -H "Authorization: Bearer <your-personal-key>"
``` ```
## Rendered And Raw Content ## Rendered And Raw Content

4
docs/deployment.md
View file

@ -77,7 +77,7 @@ docker compose -f deploy/docker-compose.yml up -d --build
``` ```
Create your first login (superuser) so you have something to log in with and Create your first login (superuser) so you have something to log in with and
a personal API token to post through: a personal API key to post through:
```bash ```bash
docker compose -f deploy/docker-compose.yml exec agentfeed python manage.py createsuperuser docker compose -f deploy/docker-compose.yml exec agentfeed python manage.py createsuperuser
@ -100,7 +100,7 @@ smoke-test post:
```bash ```bash
curl -fsS -X POST http://127.0.0.1:8000/api/artifacts \ curl -fsS -X POST http://127.0.0.1:8000/api/artifacts \
-H "Authorization: Bearer <your-personal-token>" \ -H "Authorization: Bearer <your-personal-key>" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d '{ -d '{
"source": "deploy-smoke", "source": "deploy-smoke",

2
docs/llm_posting_helper.md
View file

@ -20,7 +20,7 @@ them, or set them in your agent harness's own env config.
```text ```text
AGENTFEED_URL=http://127.0.0.1:8001 AGENTFEED_URL=http://127.0.0.1:8001
AGENTFEED_TOKEN=your-personal-api-token AGENTFEED_TOKEN=your-personal-api-key
AGENTFEED_SOURCE=agent AGENTFEED_SOURCE=agent
``` ```

4
skills/agentfeed-posting/scripts/agentfeed_post.py
View file

@ -27,7 +27,7 @@ DEFAULT_SOURCE = "agent"
def main(): def main():
args = parse_args() args = parse_args()
base_url = os.environ.get("AGENTFEED_URL", DEFAULT_URL).rstrip("/") base_url = os.environ.get("AGENTFEED_URL", DEFAULT_URL).rstrip("/")
# AGENTFEED_TOKEN is your personal per-user token (Settings -> API Keys in the app); # AGENTFEED_TOKEN is your personal per-user API key (Settings -> API Keys in the app);
# there is no shared fallback token, so posting without it cannot work. # there is no shared fallback token, so posting without it cannot work.
token = os.environ.get("AGENTFEED_TOKEN", "") token = os.environ.get("AGENTFEED_TOKEN", "")
source = args.source or os.environ.get("AGENTFEED_SOURCE", DEFAULT_SOURCE) source = args.source or os.environ.get("AGENTFEED_SOURCE", DEFAULT_SOURCE)
@ -43,7 +43,7 @@ def main():
if not token: if not token:
print( print(
"error: AGENTFEED_TOKEN is not set. Get your personal API token from " "error: AGENTFEED_TOKEN is not set. Get your personal API key from "
f"{base_url}/settings/api-keys/ and set AGENTFEED_TOKEN.", f"{base_url}/settings/api-keys/ and set AGENTFEED_TOKEN.",
file=sys.stderr, file=sys.stderr,
) )