Configuration
Learn how to configure Deeployd for your organization's needs.
Agent Configuration
Basic Settings
Every agent has these core settings:
| Setting | Description | Default |
|---|---|---|
| Name | Display name for the agent | Required |
| Description | What this agent does | Optional |
| Model | AI model to use | Claude 3.5 Sonnet |
| Temperature | Response creativity (0-1) | 0.7 |
| Max Tokens | Maximum response length | 4096 |
Model Selection
Choose the right model for your use case:
| Model | Best For | Speed | Cost |
|---|---|---|---|
| Claude 3.5 Sonnet | General tasks, balanced performance | Fast | Medium |
| Claude 3 Opus | Complex reasoning, nuanced responses | Slower | Higher |
| Claude 3 Haiku | Simple tasks, high volume | Fastest | Lowest |
// Set model via API
await deeployd.agents.update({
agentId: 'agent-id',
model: 'claude-3-5-sonnet-20241022',
temperature: 0.5,
maxTokens: 2048
});
Advanced Settings
| Setting | Description | Default |
|---|---|---|
| System Prompt Protected | Prevent prompt injection attacks | true |
| Memory Enabled | Allow agent to remember context | true |
| Tools Enabled | Allow agent to use tools | true |
| Streaming | Stream responses in real-time | true |
Workspace Configuration
Tenant Settings
Configure your organization:
Settings → Organization → General
| Setting | Description |
|---|---|
| Workspace Name | Your organization name |
| Timezone | Default timezone for schedules |
| Language | Primary language for UI |
Team Management
Organize users into teams:
Settings → Teams → Create Team
| Role | Permissions |
|---|---|
| Owner | Full access, billing, delete workspace |
| Admin | Manage users, agents, integrations |
| Member | Use agents, view analytics |
| Viewer | Read-only access |
API Keys
Create and manage API keys:
Settings → API Keys → Create Key
| Option | Description |
|---|---|
| Name | Identify the key's purpose |
| Scopes | Limit what the key can access |
| Expiration | Auto-expire for security |
| IP Allowlist | Restrict to specific IPs |
// API key with limited scopes
const key = await deeployd.apiKeys.create({
name: 'Production Website',
scopes: ['agents:chat', 'agents:read'],
expiresAt: '2025-12-31',
allowedIps: ['203.0.113.0/24']
});
Security Configuration
Authentication
Configure how users sign in:
Settings → Security → Authentication
| Option | Description |
|---|---|
| Password Policy | Minimum requirements |
| MFA Required | Enforce two-factor auth |
| Session Timeout | Auto-logout after inactivity |
| SSO Provider | Configure SAML/OIDC |
SSO Setup
For enterprise SSO:
- Go to Settings → Security → SSO
- Select your identity provider
- Configure SAML or OIDC settings
- Test the connection
- Enable for your workspace
Supported providers:
- Okta
- Azure AD
- Google Workspace
- OneLogin
- Custom SAML 2.0
Audit Logging
Track all actions in your workspace:
Settings → Security → Audit Logs
Events logged:
- User sign-ins and sign-outs
- Agent creation and modification
- API key usage
- Configuration changes
- Data exports
// Query audit logs via API
const logs = await deeployd.auditLogs.list({
startDate: '2024-01-01',
endDate: '2024-01-31',
eventTypes: ['agent.created', 'agent.updated'],
userId: 'user-123'
});
Integration Configuration
Google Workspace
Settings → Integrations → Google Workspace
- Connect - OAuth flow with admin account
- Select Services - Gmail, Calendar, Drive, Admin
- Configure Scopes - Minimum necessary permissions
- Test Connection - Verify access works
Microsoft 365
Settings → Integrations → Microsoft 365
- Connect - OAuth flow with admin account
- Grant Permissions - Azure AD app permissions
- Configure Scopes - Select required APIs
- Test Connection - Verify access works
Webhooks
Receive events from Deeployd:
Settings → Integrations → Webhooks
| Setting | Description |
|---|---|
| URL | Your endpoint |
| Events | Which events to send |
| Secret | Verify webhook authenticity |
| Retry | Retry failed deliveries |
// Example webhook payload
{
"event": "conversation.completed",
"timestamp": "2024-01-15T10:30:00Z",
"data": {
"conversationId": "conv-123",
"agentId": "agent-456",
"messageCount": 5,
"tokensUsed": 1250
}
}
Environment Variables
For self-hosted or advanced setups:
| Variable | Description | Required |
|---|---|---|
DEEPLOYD_API_KEY | Your API key | Yes |
DEEPLOYD_API_URL | API endpoint | No |
DEEPLOYD_TIMEOUT | Request timeout (ms) | No |
DEEPLOYD_RETRY_COUNT | Retry attempts | No |
# .env file
DEEPLOYD_API_KEY=sk_live_...
DEEPLOYD_API_URL=https://api.deeployd.com
DEEPLOYD_TIMEOUT=30000
DEEPLOYD_RETRY_COUNT=3
Rate Limits
Default rate limits by plan:
| Plan | Requests/min | Tokens/month |
|---|---|---|
| Starter | 60 | 100K |
| Pro | 300 | 1M |
| Business | 1000 | 10M |
| Enterprise | Custom | Custom |
Rate limit headers:
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1705312200
Configuration Files
Export and import agent configurations:
// Export agent configuration
const config = await deeployd.agents.export('agent-id');
// Import to new agent
await deeployd.agents.import(config, {
name: 'Cloned Agent'
});
Configuration includes:
- System prompt
- Model settings
- Tool configurations
- Memory settings
- Workflow connections
Need help? See Troubleshooting or ask in Discord