Skip to main content

Configuration

Learn how to configure Deeployd for your organization's needs.

Agent Configuration

Basic Settings

Every agent has these core settings:

SettingDescriptionDefault
NameDisplay name for the agentRequired
DescriptionWhat this agent doesOptional
ModelAI model to useClaude 3.5 Sonnet
TemperatureResponse creativity (0-1)0.7
Max TokensMaximum response length4096

Model Selection

Choose the right model for your use case:

ModelBest ForSpeedCost
Claude 3.5 SonnetGeneral tasks, balanced performanceFastMedium
Claude 3 OpusComplex reasoning, nuanced responsesSlowerHigher
Claude 3 HaikuSimple tasks, high volumeFastestLowest
// Set model via API
await deeployd.agents.update({
agentId: 'agent-id',
model: 'claude-3-5-sonnet-20241022',
temperature: 0.5,
maxTokens: 2048
});

Advanced Settings

SettingDescriptionDefault
System Prompt ProtectedPrevent prompt injection attackstrue
Memory EnabledAllow agent to remember contexttrue
Tools EnabledAllow agent to use toolstrue
StreamingStream responses in real-timetrue

Workspace Configuration

Tenant Settings

Configure your organization:

Settings → Organization → General
SettingDescription
Workspace NameYour organization name
TimezoneDefault timezone for schedules
LanguagePrimary language for UI

Team Management

Organize users into teams:

Settings → Teams → Create Team
RolePermissions
OwnerFull access, billing, delete workspace
AdminManage users, agents, integrations
MemberUse agents, view analytics
ViewerRead-only access

API Keys

Create and manage API keys:

Settings → API Keys → Create Key
OptionDescription
NameIdentify the key's purpose
ScopesLimit what the key can access
ExpirationAuto-expire for security
IP AllowlistRestrict 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
OptionDescription
Password PolicyMinimum requirements
MFA RequiredEnforce two-factor auth
Session TimeoutAuto-logout after inactivity
SSO ProviderConfigure SAML/OIDC

SSO Setup

For enterprise SSO:

  1. Go to SettingsSecuritySSO
  2. Select your identity provider
  3. Configure SAML or OIDC settings
  4. Test the connection
  5. 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
  1. Connect - OAuth flow with admin account
  2. Select Services - Gmail, Calendar, Drive, Admin
  3. Configure Scopes - Minimum necessary permissions
  4. Test Connection - Verify access works

Microsoft 365

Settings → Integrations → Microsoft 365
  1. Connect - OAuth flow with admin account
  2. Grant Permissions - Azure AD app permissions
  3. Configure Scopes - Select required APIs
  4. Test Connection - Verify access works

Webhooks

Receive events from Deeployd:

Settings → Integrations → Webhooks
SettingDescription
URLYour endpoint
EventsWhich events to send
SecretVerify webhook authenticity
RetryRetry 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:

VariableDescriptionRequired
DEEPLOYD_API_KEYYour API keyYes
DEEPLOYD_API_URLAPI endpointNo
DEEPLOYD_TIMEOUTRequest timeout (ms)No
DEEPLOYD_RETRY_COUNTRetry attemptsNo
# .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:

PlanRequests/minTokens/month
Starter60100K
Pro3001M
Business100010M
EnterpriseCustomCustom

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