Skip to Content
Getting StartedConfiguration

Configuration

All configuration is done via environment variables. Copy .env.example to .env and modify as needed.

Batch Processing

VariableDefaultDescription
BATCH_SIZE_THRESHOLD100Requests per batch before auto-submit
BATCH_TIME_THRESHOLD_SECONDS3600Max wait time (1 hour) before batching
BATCH_CHECK_INTERVAL_SECONDS30How often to check for pending requests

Callback Delivery

VariableDefaultDescription
CALLBACK_MAX_RETRIES5Max delivery attempts
CALLBACK_HTTP_TIMEOUT_SECONDS30HTTP timeout per attempt

Retry intervals: 1min → 5min → 15min → 1hr (exponential backoff)

Result Cleanup

VariableDefaultDescription
RESULT_RETENTION_DAYS30Days to keep results before cleanup
CLEANUP_BATCH_SIZE1000Records per cleanup batch

Database

VariableDefaultDescription
DATABASE_URL-PostgreSQL connection string
DATABASE_ECHOfalseLog SQL queries

Example:

DATABASE_URL=postgresql+asyncpg://convoy:convoy@localhost:5433/convoy

Temporal

VariableDefaultDescription
TEMPORAL_ADDRESStemporal:7233Temporal server address
TEMPORAL_NAMESPACEdefaultTemporal namespace
TEMPORAL_TASK_QUEUEconvoy-tasksTask queue name

AWS Bedrock

VariableDescription
AWS_REGIONAWS region (e.g., us-east-1)
AWS_PROFILEAWS credentials profile
BEDROCK_S3_BUCKETS3 bucket for batch I/O
BEDROCK_ROLE_ARNIAM role for Bedrock batch
BEDROCK_S3_INPUT_PREFIXS3 prefix for inputs
BEDROCK_S3_OUTPUT_PREFIXS3 prefix for outputs

Anthropic

VariableDescription
ANTHROPIC_API_KEYYour Anthropic API key

Example .env

# Database DATABASE_URL=postgresql+asyncpg://convoy:convoy@localhost:5433/convoy # Batch settings BATCH_SIZE_THRESHOLD=100 BATCH_TIME_THRESHOLD_SECONDS=3600 # AWS Bedrock AWS_REGION=us-east-1 BEDROCK_S3_BUCKET=my-convoy-bucket BEDROCK_ROLE_ARN=arn:aws:iam::123456789:role/BedrockBatchRole # Anthropic (optional) ANTHROPIC_API_KEY=sk-ant-...
Last updated on