Skip to content

Commit 3cb793d

Browse files
committed
docs(readme): note bearer auth required for REST API examples
the /api/* curl examples omit the Authorization header though the endpoints are behind BearerAuth; add a single leading note covering the credential, pool, and rule examples.
1 parent 148a54e commit 3cb793d

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,11 @@ Manage sluice from your phone. Approve connections and tool calls, add credentia
343343

344344
REST API on port 3000 for programmatic approval integration. `GET /api/approvals` lists pending requests, `POST /api/approvals/{id}/resolve` resolves them. Use this to build custom approval UIs or integrate with existing workflows.
345345

346+
All `/api/*` endpoints below are protected by bearer auth. Every request must
347+
send `Authorization: Bearer $SLUICE_API_TOKEN` (the token sluice prints at
348+
startup). The curl examples omit the header for brevity, but it is required
349+
for the credential, pool, and rule calls shown here.
350+
346351
Credential management endpoints support both static and OAuth types:
347352

348353
```bash

0 commit comments

Comments
 (0)