API Reference
Postman Collections
Download pre-built Postman collections for testing every API endpoint in the Teamcast Maya platform.
Three ready-to-import Postman collections cover the entire Teamcast Maya API surface -- 96+ requests organized by domain, with auto-extraction scripts that save tokens, IDs, and runIds to environment variables as you test.
The Platform Admin and Tenant Admin collections are for Teamcast internal staff managing the platform dashboard and provisioning tenants. Platform Admin has read-only access to API keys -- API keys are issued exclusively by Teamcast Super Admin.
Import into Postman
Download the JSON files below, then use File > Import in Postman (or drag-and-drop) to load them instantly.
Environment Setup
Start by importing the shared environment file. It contains all variables used across the three collections -- base URL, credentials, and auto-populated IDs.
Teamcast Maya - Local Dev Environment
Pre-configured for localhost:3009. Update baseUrl for staging/production.
| Variable | Auto-set? | Description |
|---|---|---|
| baseUrl | No | API base URL (default: http://localhost:3009/api/v1) |
| jwt_token | Yes | Tenant Admin JWT — set after Tenant Admin Login (internal staff only) |
| pa_jwt_token | Yes | Platform Admin JWT — set after Platform Admin Login (internal staff only) |
| apiKey | No | Your API key — provisioned by Teamcast Super Admin and shared with you. Used for all Integration API calls. |
| apiKeyId | No | API key UUID — provided by Teamcast Super Admin alongside the key value. |
| tenantId | Yes | Your Tenant UUID — set after login or passed manually. Required as X-Tenant-ID header in all Integration API calls. |
| platformId | No | Set manually from Platform Admin portal |
| interviewId | Yes | Set after creating an interview |
| runId | Yes | Set after Submit Interview Request — use this in all subsequent Integration API calls |
| userId | Yes | Set after creating a user |
| roleId | Yes | Set after creating a role |
| candidateToken | No | Set from the interview join link sent to candidate |
| sessionToken | Yes | Set after Verify OTP |
| sessionId | Yes | Set after Start Interview |
| invitationToken | No | Set from invitation email link |
| interviewLink | Yes | Set after Approve Plan — the candidate-facing URL |
Collections
Interview Integration APIs
The external client collection. Everything your ATS or HRIS needs — interview lifecycle, plan & assessment approvals, candidate access, and agent discovery. API key auth only, no JWT required.
Platform Admin APIs
Teamcast internal use. Platform Admin login, tenant provisioning, platform user management, API key visibility (read-only), tenant invitations, and health checks.
Tenant Admin APIs
Teamcast internal use. Admin dashboard operations — users, roles and permissions, interviews (CRUD + conduct + invite), workflow state machine, MCP skills, API keys, OAuth clients, webhook config, DLQ, and recording.
Quick Start: External Integration (API Key Only)
If you are integrating an external ATS, HRIS, or recruitment platform with Teamcast Maya, this is the only flow you need. No JWT login, no session management -- just your API key and Tenant ID on every request.
apiKey and tenantId in your Postman environment before starting. Both are issued to you by your Platform Admin.1. Submit and Drive the Interview
- Run Submit Interview Request -- auto-saves
runId - Run Get Interview Status -- check
statefield - If
INFO_NEEDED: run Supply Missing Info - When
PENDING: run Approve Plan -- auto-savesinterviewLink - When
ASSESSMENT_PENDING: run Approve Assessment
2. Candidate Flow (no auth — token-based)
- Copy token from
interviewLinkintocandidateToken - Run Get Interview Info (Candidate Access)
- Run Request OTP then Verify OTP -- auto-saves
sessionToken - Run Start Interview -- auto-saves
sessionId - Run Trigger AI Greeting
- Run End Interview to trigger the assessor
Quick Start: Platform Admin Setup (Internal Staff)
Teamcast Platform Admins use this flow to provision tenants and issue API keys to external integration partners.
1. Platform Admin Setup
- Run Login (Platform Admin collection) -- auto-saves
pa_jwt_token - Run Create Tenant -- auto-saves
tenantId - Teamcast Super Admin issues an API key via
POST /super-admin/platforms/:id/api-keys-- auto-savesapiKey - Share
apiKeyandtenantIdwith the external system
2. Tenant Admin (internal dashboard)
- Run Tenant Admin Login -- auto-saves
jwt_tokenandtenantId - Use Users, Roles, Interviews, Workflow, and other admin endpoints as needed
Authentication Modes
Each collection is pre-configured with the appropriate auth mode.
| Collection | Who Uses It | Auth | Headers Required |
|---|---|---|---|
| Interview Integration APIs | External ATS / HRIS systems | API Key only | X-API-Key + X-Tenant-ID |
| Platform Admin APIs | Teamcast internal staff | Bearer JWT (pa_jwt_token) | Authorization: Bearer <token> |
| Tenant Admin APIs | Teamcast internal staff | Bearer JWT (jwt_token) | Authorization: Bearer <token> |
X-API-Key header along with X-Tenant-ID on every request. JWT tokens are never required for external integrations.Auto-Extraction Scripts
Key requests include Postman test scripts that auto-save response values to environment variables. This lets you run requests in sequence without manually copying IDs.
// Runs automatically after the Login request
if (pm.response.code === 200) {
const json = pm.response.json();
pm.environment.set('pa_jwt_token', json.accessToken);
}Requests that auto-save variables: Platform Admin Login, Tenant Admin Login, Create Tenant, Create Interview, Submit Interview Request (runId), Verify OTP (sessionToken), Start Interview (sessionId), and Approve Plan (interviewLink).