Skip to main content

Welcome to DeePsy for Devs

· 3 min read
ARJI Amin
ARJI Amin
CTO @deepsy.fr

We're excited to announce the launch of our comprehensive API documentation for DeePsy v1! 🎉

DeePsy is a cutting-edge psychology and mental health platform that provides powerful tools for psychological assessment, candidate evaluation, and mental health insights. Our API enables developers to integrate DeePsy's advanced psychological assessment capabilities into their own applications and workflows.

What's New in Our API Documentation​

🚀 Complete Dashboard Dashboard API Reference​

Our new documentation provides comprehensive coverage of all DeePsy API v1 endpoints, including:

  • User Management: Manage user profiles and company memberships
  • Company Administration: Handle company settings, users, and invitations
  • Campaign Management: Create and manage psychological assessment campaigns
  • Candidate Assessment: Evaluate candidates and generate detailed psychological reports
  • White Label Solutions: Customize branding and create white-label experiences
  • Asset Management: Upload and manage campaign assets

📚 Detailed Guides​

We've created in-depth guides covering:

🔧 Interactive API Explorer​

Test our API endpoints directly in the browser with our interactive API explorer. No need to set up external tools - everything you need is right here in the documentation.

Key Features of DeePsy API v1​

Advanced Permission System​

DeePsy uses a sophisticated bitfield-based permission system that provides granular control over API access:

  • FOUNDER: Complete platform access
  • ADMINISTRATOR: Company management and user administration
  • MANAGE_CAMPAIGN: Campaign creation and candidate management
  • FINANCE: Billing and subscription management
  • REPORT: Analytics and report generation
  • EMAIL: Communication and notification management

Comprehensive Assessment Tools​

Our API provides access to DeePsy's advanced psychological assessment capabilities:

  • Personality Assessments: Industry-standard psychological evaluations
  • Cognitive Testing: Measure cognitive abilities and potential
  • Behavioral Analysis: Understand behavioral patterns and tendencies
  • Custom Assessments: Create tailored evaluation workflows

Enterprise-Ready Features​

Built for scale with enterprise-grade features:

  • Multi-Company Support: Manage multiple organizations from a single account
  • White Label Solutions: Customize branding for your clients
  • Bulk Operations: Process multiple candidates efficiently
  • Detailed Reporting: Generate comprehensive psychological reports

Getting Started​

Ready to integrate DeePsy into your application? Here's how to get started:

  1. Create an API Key - Set up secure authentication
  2. Explore the API - Browse our comprehensive Dashboard API Reference
  3. Follow the Quick Start - Build your first integration
  4. Join Our Community - Get support and connect with other developers

What's Next?​

We're continuously improving our API and documentation. Coming soon:

  • SDK Libraries: Official SDKs for popular programming languages
  • Webhook Support: Real-time notifications for assessment completions
  • Advanced Analytics: Enhanced reporting and insights capabilities
  • Mobile SDKs: Native mobile integration options

Support and Feedback​

We're here to help you succeed with DeePsy API:

Thank you for choosing DeePsy for your psychological assessment needs. We can't wait to see what you'll build with our API! 🚀

ARJI Amin, CTO @deepsy.fr