Skip to content

docs: cloud embedding api #10137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 13, 2025
Merged

docs: cloud embedding api #10137

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd7cb4b
docs: cloud embedding api
vasilev-alex Nov 13, 2025
0eab27c
fix
vasilev-alex Nov 13, 2025
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
17 changes: 16 additions & 1 deletion docs/pages/product/apis-integrations/embedding.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,21 @@ Use the `/api/v1/embed/generate-session` endpoint to create a session for your u
</WarningBox>


#### Request parameters

- **`deploymentId`** (required): The deployment ID to scope the session to. This ensures tokens and access are limited to a specific deployment and model, providing better security isolation.
- **`externalId`** (required): A unique identifier for your user (e.g., email, user ID)
- **`userAttributes`** (optional): Array of attributes for row-level security and personalized responses

<InfoBox>
The `deploymentId` parameter is required for security purposes. It scopes the generated session token to a specific deployment and data model, preventing unauthorized access across different deployments or models.
</InfoBox>

#### Example (JavaScript)

```javascript
const API_KEY = "YOUR_API_KEY";
const DEPLOYMENT_ID = 32;

const session = await fetch(
"https://your-tenant.cubecloud.dev/api/v1/embed/generate-session",
Expand All @@ -49,6 +60,7 @@ const session = await fetch(
Authorization: "Access-Token ${API_KEY}",
},
body: JSON.stringify({
deploymentId: DEPLOYMENT_ID,
externalId: "[email protected]",
userAttributes: [
// optional - enables row-level security
Expand Down Expand Up @@ -99,6 +111,7 @@ Here's a complete HTML example that demonstrates the full flow for embedding a d
(async () => {
const API_BASE_URL = "https://your-tenant.cubecloud.dev";
const API_KEY = "YOUR_API_KEY";
const DEPLOYMENT_ID = 32;
const externalId = "[email protected]";
const sessionResponse = await fetch(
Expand All @@ -110,6 +123,7 @@ Here's a complete HTML example that demonstrates the full flow for embedding a d
Authorization: `Access-Token ${API_KEY}`,
},
body: JSON.stringify({
deploymentId: DEPLOYMENT_ID,
externalId: externalId,
}),
},
Expand Down Expand Up @@ -165,6 +179,7 @@ User attributes enable row-level security and personalized chat responses by fil
## Security considerations

- **API Key Security**: Keep your API keys secure and never expose them in client-side code
- **Deployment Scoping**: The required `deploymentId` parameter ensures that generated session tokens are scoped to a specific deployment and data model. This provides isolation between different deployments and prevents unauthorized cross-deployment access.
- **Session Management**: Sessions are temporary and should be regenerated as needed
- **HTTPS**: Always use HTTPS in production environments

Expand All @@ -187,4 +202,4 @@ If you encounter issues with dashboard embedding:
- Contact support if you need assistance with configuration


[ref-api-keys]: /product/workspace/api-keys
[ref-api-keys]: /product/workspace/api-keys