Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .changeset/fair-hairs-turn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
'@rushdb/javascript-sdk': patch
'rushdb-core': patch
'rushdb-docs': patch
'@rushdb/mcp-server': patch
'@rushdb/skills': patch
'rushdb-dashboard': patch
---

Minor fixes
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ jobs:
{ "name": "RUSHDB_AES_256_ENCRYPTION_KEY", "value": "${{ secrets.RUSHDB_AES_256_ENCRYPTION_KEY }}" },
{ "name": "RUSHDB_JWT_PRIVATE_KEY_BASE64", "value": "${{ secrets.RUSHDB_JWT_PRIVATE_KEY_BASE64 }}" },
{ "name": "RUSHDB_JWT_PUBLIC_KEY_BASE64", "value": "${{ secrets.RUSHDB_JWT_PUBLIC_KEY_BASE64 }}" },
{ "name": "RUSHDB_JWT_KID", "value": "${{ vars.RUSHDB_JWT_KID }}" },
{ "name": "RUSHDB_JWT_KID", "value": "${{ secrets.RUSHDB_JWT_KID }}" },
{ "name": "RUSHDB_SELF_HOSTED", "value": "false" },
{ "name": "RUSHDB_SERVE_STATIC", "value": "false" },
{ "name": "NEO4J_URL", "value": "${{ secrets.NEO4J_URL }}" },
Expand All @@ -219,7 +219,7 @@ jobs:
{ "name": "SQL_DB_URL", "value": "${{ secrets.SQL_DB_URL }}" },
{ "name": "RUSHDB_PUBLIC_URL", "value": "${{ vars.RUSHDB_PUBLIC_URL }}" },
{ "name": "RUSHDB_OAUTH_ISSUER", "value": "${{ vars.RUSHDB_PUBLIC_URL }}" },
{ "name": "RUSHDB_EMBEDDING_BASE_URL", "value": "${{ secrets.RUSHDB_EMBEDDING_BASE_URL }}" },
{ "name": "RUSHDB_EMBEDDING_BASE_URL", "value": "${{ vars.RUSHDB_EMBEDDING_BASE_URL }}" },
{ "name": "RUSHDB_EMBEDDING_API_KEY", "value": "${{ secrets.RUSHDB_EMBEDDING_API_KEY }}" },
{ "name": "RUSHDB_EMBEDDING_MODEL", "value": "${{ vars.RUSHDB_EMBEDDING_MODEL }}" },
{ "name": "RUSHDB_EMBEDDING_DIMENSIONS", "value": "${{ vars.RUSHDB_EMBEDDING_DIMENSIONS }}" },
Expand Down
17 changes: 12 additions & 5 deletions docs/docs/get-started/get-api-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,17 @@ Your API token will be displayed only once. Make sure to:

Example of using environment variables:

import Tabs from '@site/src/components/LanguageTabs';
import TabItem from '@theme/TabItem';
import Tabs from '@site/src/components/LanguageTabs'
import TabItem from '@theme/TabItem'

<Tabs groupId="programming-language">
<TabItem value="python" label="Python" default>
```python
import os

db = RushDB(api_key=os.environ['RUSHDB_API_KEY'])
```

````
</TabItem>
<TabItem value="typescript" label="TypeScript">
```typescript
Expand All @@ -54,16 +55,19 @@ const db = new RushDB();

// Or pass it explicitly:
// const db = new RushDB(process.env.RUSHDB_API_KEY);
```
````

</TabItem>
<TabItem value="shell" label="shell">
```bash
# Set in your shell
export RUSHDB_API_KEY='your-api-key'

# Use in requests

curl -H "Authorization: Bearer $RUSHDB_API_KEY" \
https://api.rushdb.com/api/v1/records
https://api.rushdb.com/api/v1/records

```
</TabItem>
</Tabs>
Expand All @@ -78,5 +82,8 @@ curl -H "Authorization: Bearer $RUSHDB_API_KEY" \
## Next Steps

- Follow the [Quick Tutorial](../get-started/quick-tutorial) to start using your token
- Connect an AI agent via the [MCP Server](../mcp-server/quickstart)
- Bootstrap agent memory with the [Agent Setup guide](https://rushdb.com/agent-setup)
- Learn about [RushDB](../concepts/records)
- Check out the [Basic Concepts](../concepts/records)
```
Loading
Loading