Documentation

Technical guides and API reference for TODAY Type

Overview

The TODAY Type API allows you to integrate typing training and assessment capabilities into your applications. Use the API to manage users, administer tests, and retrieve performance data programmatically.

The API is available for Professional and Enterprise customers. Contact us to enable API access for your account.

Base URL

https://type.tdy.ai/api/v1

Response Format

All API responses are returned in JSON format. Successful responses include a data object, while errors include an error object with details.

Authentication

The API uses Bearer token authentication. Include your API key in the Authorization header of each request:

Authorization: Bearer your-api-key-here

You can generate and manage API keys from your account settings. Keep your API keys secure and never expose them in client-side code.

Quick Start

Here's a simple example to get you started. This request retrieves a list of users in your organization:

curl -X GET "https://type.tdy.ai/api/v1/users" \
  -H "Authorization: Bearer your-api-key" \
  -H "Content-Type: application/json"
        

Users Coming Soon

Manage users in your organization.

GET /users

Retrieve a list of all users in your organization.

POST /users

Create a new user and send them an invitation.

GET /users/{id}

Retrieve details for a specific user.

Tests Coming Soon

Manage typing tests and assessments.

GET /tests

List available test templates.

POST /tests/assign

Assign a test to one or more users.

Results Coming Soon

Retrieve test results and performance data.

GET /results

Get test results with optional filtering by user, date range, or test type.

Reports Coming Soon

Generate and download reports.

POST /reports/generate

Generate a performance report for your organization or specific users.

SSO Setup Enterprise

Enterprise customers can configure Single Sign-On (SSO) using SAML 2.0. Contact your account manager or enterprise@tdy.ai for SSO configuration assistance.

We support integration with:

Microsoft Azure AD
Okta
OneLogin
Google Workspace
Other SAML 2.0 providers

Webhooks Coming Soon

Receive real-time notifications when events occur in your TODAY Type account. Webhooks can notify you when:

A user completes a test
A user achieves a new personal best
A challenge is completed
New users are added

Need help with the API?
Contact our technical team at api@tdy.ai or visit our Help Center.