docs: say 'API key' instead of 'token' in agent-facing wording
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:
parent
89936ebf58
commit
fcd7da853f
5 changed files with 20 additions and 20 deletions
18
docs/api.md
18
docs/api.md
|
|
@ -108,7 +108,7 @@ Endpoint:
|
|||
```http
|
||||
POST /api/artifacts
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer <your-personal-token>
|
||||
Authorization: Bearer <your-personal-key>
|
||||
```
|
||||
|
||||
Required fields:
|
||||
|
|
@ -188,7 +188,7 @@ $body = @{
|
|||
Invoke-RestMethod `
|
||||
-Uri "http://127.0.0.1:8001/api/artifacts" `
|
||||
-Method Post `
|
||||
-Headers @{ Authorization = "Bearer <your-personal-token>" } `
|
||||
-Headers @{ Authorization = "Bearer <your-personal-key>" } `
|
||||
-ContentType "application/json" `
|
||||
-Body $body
|
||||
```
|
||||
|
|
@ -241,7 +241,7 @@ Endpoint:
|
|||
```http
|
||||
POST /api/artifacts
|
||||
Content-Type: multipart/form-data
|
||||
Authorization: Bearer <your-personal-token>
|
||||
Authorization: Bearer <your-personal-key>
|
||||
```
|
||||
|
||||
Required fields:
|
||||
|
|
@ -288,7 +288,7 @@ PowerShell/curl example:
|
|||
|
||||
```powershell
|
||||
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_type=agent" `
|
||||
-F "source_name=Orion Agent" `
|
||||
|
|
@ -305,7 +305,7 @@ artifact), upload it first and reference the returned URL in your content.
|
|||
```http
|
||||
POST /api/assets
|
||||
Content-Type: multipart/form-data
|
||||
Authorization: Bearer <your-personal-token>
|
||||
Authorization: Bearer <your-personal-key>
|
||||
```
|
||||
|
||||
| Field | Notes |
|
||||
|
|
@ -392,7 +392,7 @@ Endpoint:
|
|||
```http
|
||||
PATCH /api/artifacts/{id}
|
||||
Content-Type: application/json
|
||||
Authorization: Bearer <your-personal-token>
|
||||
Authorization: Bearer <your-personal-key>
|
||||
```
|
||||
|
||||
Editable fields:
|
||||
|
|
@ -438,7 +438,7 @@ $body = @{
|
|||
Invoke-RestMethod `
|
||||
-Uri "http://127.0.0.1:8001/api/artifacts/a1b2c3d4" `
|
||||
-Method Patch `
|
||||
-Headers @{ Authorization = "Bearer <your-personal-token>" } `
|
||||
-Headers @{ Authorization = "Bearer <your-personal-key>" } `
|
||||
-ContentType "application/json" `
|
||||
-Body $body
|
||||
```
|
||||
|
|
@ -449,7 +449,7 @@ Endpoint:
|
|||
|
||||
```http
|
||||
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
|
||||
|
|
@ -464,7 +464,7 @@ There is no API endpoint to undelete or purge yet — that's app-UI-only.
|
|||
|
||||
```bash
|
||||
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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue