Integration overview

SmallTalk Assessment automates the language assessment process. The API lets an organization integrate that experience into its existing business workflow.

Terminology

This documentation uses the following terms:

• Test: A language test available to send to a candidate. Tests are returned by list_tests, and a selected test is identified by test_id.
• Assessment: One test sent to one candidate. It is identified by the interview_id field.
• Candidate: The person who completes an assessment.
• Organization: The SmallTalk account that owns the available tests and API token.

Organization setup

1. The organization creates a SmallTalk account.
2. In the B2B dashboard, the organization goes to Integration Settings and selects Create API Token.
3. Store that token in the integration configuration.
4. Send the token in the Authorization header on every API request.

Assessment flow

1. Select a test and candidate.
2. Send the test invitation.
3. Provide the returned test_link to the candidate yourself, or use SmallTalk's email delivery.
4. The candidate completes the assessment on the SmallTalk website.
5. After the report is generated, SmallTalk can notify the organization's callback URL.
6. The organization requests the latest assessment status and results.

Base URL

https://app.smalltalk2.me/api/integration

Authentication

In the B2B dashboard, go to Integration Settings and select Create API Token.

Authorization: Bearer <token>

Keep the token on your server. Do not expose it in browser code or commit it to source control.

Core endpoints

Method	Path	Purpose
GET	/list_tests	List tests available to the organization.
POST	/send_test	Create and send a candidate assessment.
GET	/test_status	Read assessment status and results.

Continue with the quickstart or open the API reference.