Commands for managing your memory file’s capacity and syncing tickets from the dashboard.
Overview Memvid uses a ticket system for capacity management:
Tickets authorize storage capacityBinding connects a file to a dashboard memoryPlans determine your capacity limits
memvid tickets sync Synchronize tickets from the dashboard.
Synopsis memvid tickets sync < FIL E > --memory-id < I D > [OPTIONS]
Arguments Argument Description FILEPath to the .mv2 file
Options Option Description Default --memory-id <ID>Memory ID (UUID or 24-char ObjectId) Required --jsonJSON output Disabled --lock-timeout <MS>Wait timeout for lock 250ms --forceForce lock takeover Disabled
Examples # Sync with dashboard memory memvid tickets sync project.mv2 --memory-id mem_abc123 # With environment API key MEMVID_API_KEY = mv_live_xxx memvid tickets sync project.mv2 --memory-id mem_abc123
Response Syncing tickets for project.mv2... Memory ID: mem_abc123 Memory Name: Production Memory Ticket applied: Issuer: memvid.com Sequence: 43 (was: 42) Capacity: 1 GB Expires in: 30d Binding status: Already bound: yes Sync complete.
JSON Output { "success" : true , "memory_id" : "mem_abc123" , "already_bound" : true , "ticket" : { "issuer" : "memvid.com" , "seq_no" : 43 , "capacity_bytes" : 1073741824 , "expires_in_secs" : 2592000 } }
memvid tickets apply Apply a ticket to a memory file.
Synopsis memvid tickets apply < FIL E > --memory-id < I D > [OPTIONS]
Options Option Description --memory-id <ID>Memory ID (required) --from-apiFetch ticket from API --jsonJSON output
Examples # Apply ticket from API memvid tickets apply project.mv2 --memory-id mem_abc123 --from-api
memvid tickets issue Issue a new ticket (for self-hosted/enterprise).
Synopsis memvid tickets issue < FIL E > [OPTIONS]
Options Option Description Default --issuer <ISSUER>Ticket issuer Required --seq <SEQ>Sequence number Required --expires-in <SECS>Expiration in seconds None --capacity <BYTES>Capacity in bytes None --jsonJSON output Disabled
Examples # Issue enterprise ticket memvid tickets issue project.mv2 \ --issuer "enterprise.example.com" \ --seq 1 \ --expires-in 31536000 \ --capacity 10737418240
memvid tickets list Show current ticket information.
Synopsis memvid tickets list < FIL E > [OPTIONS]
Options Option Description --jsonJSON output
Examples memvid tickets list project.mv2
Response Ticket for project.mv2 Status: ACTIVE Ticket Details: Issuer: memvid.com Sequence: 43 Capacity: 1 GB Expires: 2024-02-20T10:30:00Z (30d remaining) Usage: Current size: 125.6 MB Capacity: 1 GB Available: 898.4 MB Usage: 12.2%
JSON Output { "path" : "project.mv2" , "active" : true , "ticket" : { "issuer" : "memvid.com" , "seq_no" : 43 , "capacity_bytes" : 1073741824 , "expires_at" : "2024-02-20T10:30:00Z" , "expires_in_secs" : 2592000 }, "usage" : { "current_bytes" : 131691315 , "capacity_bytes" : 1073741824 , "available_bytes" : 942050509 , "usage_percent" : 12.2 } }
memvid tickets revoke Clear ticket metadata from a file.
Synopsis memvid tickets revoke < FIL E > [OPTIONS]
Options Option Description --jsonJSON output --lock-timeout <MS>Wait timeout --forceForce lock takeover
Examples memvid tickets revoke project.mv2
memvid plan show Show current plan and capacity.
Synopsis memvid plan show [OPTIONS]
Options Option Description --jsonJSON output
Examples Response Memvid Plan Plan: Developer Status: Active Limits: Memories: 10 / 25 Total capacity: 2.5 GB / 10 GB API calls: 45,231 / 100,000 (monthly) Features: - Semantic search: included - LLM enrichment: included - Table extraction: included - Encryption: included - Priority support: not included Billing: Next renewal: 2024-02-01 Amount: $29/month Upgrade: https://memvid.com/dashboard/plan
JSON Output { "plan" : "developer" , "status" : "active" , "limits" : { "memories" : { "used" : 10 , "limit" : 25 }, "capacity_bytes" : { "used" : 2684354560 , "limit" : 10737418240 }, "api_calls" : { "used" : 45231 , "limit" : 100000 , "period" : "monthly" } }, "features" : { "semantic_search" : true , "llm_enrichment" : true , "table_extraction" : true , "encryption" : true , "priority_support" : false }, "billing" : { "next_renewal" : "2024-02-01" , "amount_cents" : 2900 , "currency" : "usd" } }
memvid plan sync Sync plan ticket from dashboard.
Synopsis memvid plan sync [OPTIONS]
Options Option Description --jsonJSON output
Examples MEMVID_API_KEY = mv_live_xxx memvid plan sync
memvid plan clear Clear cached plan ticket.
Synopsis memvid plan clear [OPTIONS]
Options Option Description --jsonJSON output
Bind and Unbind Memory Bind Memory Associate a local memory file with a dashboard memory ID:
memvid bind knowledge.mv2 --memory-id YOUR_MEMORY_ID
After binding, you can sync tickets without specifying the memory ID each time.
Unbind Memory Remove the dashboard association from a local file:
memvid unbind knowledge.mv2
After unbinding, you’ll need to rebind before syncing tickets again.
Best Practices Initial Setup # 1. Create memory file memvid create project.mv2 # 2. Sync with dashboard (binds and applies ticket) MEMVID_API_KEY = mv_live_xxx memvid tickets sync project.mv2 --memory-id mem_abc123 # 3. Verify binding memvid binding project.mv2
Monitoring Capacity # Check current usage memvid tickets list project.mv2 # Check plan limits memvid plan show # Script to alert on low capacity USAGE = $( memvid tickets list project.mv2 --json | jq '.usage.usage_percent' ) if (( $( echo " $USAGE > 80" | bc - l ) )); then echo "Warning: Memory at ${ USAGE }% capacity" fi
Refreshing Tickets # Tickets are refreshed automatically on sync memvid tickets sync project.mv2 --memory-id mem_abc123 # Force refresh (re-fetch from API) memvid tickets apply project.mv2 --memory-id mem_abc123 --from-api
Enterprise Self-Hosting # Issue tickets with your own signing key memvid tickets issue project.mv2 \ --issuer "internal.company.com" \ --seq 1 \ --expires-in 31536000 \ --capacity 107374182400 # 100 GB # Verify ticket memvid tickets list project.mv2
Capacity Planning # Estimate storage needs # ~1 MB per 1000 documents (text only) # ~10 MB per 1000 documents (with embeddings) # ~50 MB per 1000 documents (with PDFs) # Check current size memvid stats project.mv2 --json | jq '.size_bytes' # Project growth # size_per_doc * docs_per_month * months
Environment Variables Variable Description MEMVID_API_KEYAPI key for ticket sync MEMVID_API_URLCustom API endpoint (default: api.memvid.com)
# Set API key globally export MEMVID_API_KEY = mv_live_xxx # Then sync without --api-key flag memvid tickets sync knowledge.mv2 --memory-id abc-123
Troubleshooting CapacityExceeded Error If you see this error when adding content:
Error: CapacityExceeded: Memory file exceeded capacity limit
Solutions:
Upgrade and sync: # After upgrading in dashboard memvid tickets sync knowledge.mv2 --memory-id YOUR_ID
Delete old content: memvid delete knowledge.mv2 --frame-id 42 --yes memvid doctor knowledge.mv2 --vacuum
Create a new memory: mv knowledge.mv2 knowledge-archive.mv2 memvid create knowledge.mv2
Ticket Sync Failed If sync fails:
# Check your API key is set echo $MEMVID_API_KEY # Verify memory ID is correct memvid tickets list knowledge.mv2 # Try with explicit API key MEMVID_API_KEY = mv_live_xxx memvid tickets sync knowledge.mv2 --memory-id YOUR_ID
Invalid Ticket Error If you see TicketInvalid or TicketReplay:
# Re-sync to get fresh ticket memvid tickets sync knowledge.mv2 --memory-id YOUR_ID
Next Steps
Maintenance & Repair Verify and repair memory files
Error Reference All error codes and solutions
