Skip to content

Commit 24fa28f

Browse files
uzunenescursoragent
andcommitted
docs: add short Security & data section (HTTPS, encryption at rest)
Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 14d10d4 commit 24fa28f

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,10 @@ health = client.health()
132132
print(health["status"]) # "ok"
133133
```
134134

135+
### Cache
136+
137+
The API caches by content (model + prompt + size). Repeat the same request to get a cache hit (`result.cache_hit == True`, lower latency and cost). See `examples/07_cache_demo.py`.
138+
135139
## Async Client
136140

137141
```python
@@ -186,6 +190,10 @@ with Client() as client:
186190
| `replicate_key` | `None` | Replicate BYOK key |
187191
| `runway_key` | `None` | Runway BYOK key |
188192

193+
## Security & data
194+
195+
All API traffic uses HTTPS. Provider API keys (BYOK) are encrypted at rest; other account and usage data is stored on Google Cloud with encryption at rest. See the [API docs](docs/API.md) for more.
196+
189197
## Examples
190198

191199
See the [`examples/`](examples/) directory for tested scripts covering every SDK feature:
@@ -201,6 +209,7 @@ See the [`examples/`](examples/) directory for tested scripts covering every SDK
201209
| `04_videos_all_providers.py` | Video generation | Yes |
202210
| `05_usage_history_verify.py` | Usage, logs, and dashboard | Yes |
203211
| `06_provider_balances.py` | Provider status and balances | Yes |
212+
| `07_cache_demo.py` | Cache: two identical image requests | Yes |
204213

205214
```bash
206215
# Run all examples in order

docs/API.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -416,6 +416,10 @@ print(f"Image: {result.image_url}")
416416
client.close()
417417
```
418418

419+
## Security & data
420+
421+
API traffic is over HTTPS. Provider keys (BYOK) are encrypted at rest; account and usage data are stored on Google Cloud with encryption at rest.
422+
419423
## Additional Resources
420424

421425
- SDK README: [README.md](../README.md)

0 commit comments

Comments
 (0)