Trimoji Softskills API Documentation
This API allows you to integrate Trimoji's personality assessment capabilities directly into your recruitment platform or workflow.
Trimoji is a personality assessment solution for recruiters. It enables sending questionnaires to candidates, which then generate results (PDF and web). A key feature is the "Personi", which represents the ideal profile for a role. You can compare a candidate's profile to a Personi to get a match score from 0 to 100.
Authentication
All API requests must be authenticated via a partner_token in the Authorization header.
Most requests also require a customer_token in the request body, identifying the specific Trimoji customer account.
| Variable | Type | Description |
|---|---|---|
base_url |
String | https://integration.trimoji.fr/api/v1/softskills |
partner_token |
String | Your unique partner token. |
customer_token |
String | Your client's Trimoji API key. |
Endpoints
1. Retrieve Campaigns
Retrieves the list of campaigns (job offers) created by the client.
Method: POST /campaigns
Request Body (JSON):
{
"customer_token": "{{customer_token}}",
"query": "test" (optional)
}
2. Create a Personi Campaign
Creates a new Personi (ideal profile) linked to a new campaign.
Method: POST /create/campaign
Main Parameters:
campaign_infos: Test configuration (short, long, result display).job_offer: Job details (title, sector, description, responsibilities).custom_id: Your unique internal ID for this offer.
3. Create a Personi (Standalone)
Creates an ideal profile without directly associating it with an immediate campaign.
Method: POST /create/personi
4. Send Assessment to Candidate
Initiates an assessment process. Generates a unique link for the candidate.
Method: POST /init
| Parameter | Description |
|---|---|
candidate_email |
Required. Candidate's email. |
callback_url |
Webhook URL to automatically receive results. |
is_trimoji_sending |
If true, Trimoji sends the email. Otherwise, you manage link distribution. |
Webhook & Results
Once the test is completed, Trimoji sends a POST to the callback_url with:
- ✅ score: Matching score (0-100).
- ✅ grade:
failed,passed, orexcelled. - ✅ web_report: Link to the full web analysis.
- ✅ file_urls: Links to PDFs (Summary, Interview, Onboarding, etc.).
5. Retrieve Process Results
Retrieves the details of a completed assessment via its ID.
Method: GET /profile/:process_id
6. Retrieve Personis
Lists all ideal profiles (Personis) created by the client.
Method: POST /personis
7. Match Process to a Personi
Compares a candidate who has already taken the test to a specific job profile to get a new score.
Method: POST /matching
{
"process_id": "CANDIDATE_TEST_ID",
"personi_id": "IDEAL_PROFILE_ID"
}