@codiris/interview-sdk

Official SDK for integrating Codiris Interview capabilities into your applications.

Installation

npm install @codiris/interview-sdk
# or
yarn add @codiris/interview-sdk
# or
pnpm add @codiris/interview-sdk

Quick Start

Basic Setup

import { InterviewClient } from '@codiris/interview-sdk';

const client = new InterviewClient({
  apiKey: 'int_live_xxxxxxxxxxxxxxxxxxxxx', // Get from Settings > SDK Keys
});

// List projects
const projects = await client.listProjects();

// Get an interview
const interview = await client.getInterview('interview-id');

React Integration

import { InterviewProvider, InterviewEmbed, useInterview } from '@codiris/interview-sdk/react';

function App() {
  return (
    <InterviewProvider config={{ apiKey: 'int_live_xxxxxxxxxxxxxxxxxxxxx' }}>
      <InterviewPage />
    </InterviewProvider>
  );
}

function InterviewPage() {
  return (
    <InterviewEmbed
      projectId="your-project-id"
      onComplete={(interview) => {
        console.log('Interview completed:', interview);
      }}
    />
  );
}

Features

• Full API Coverage: Access all Codiris Interview endpoints
• React Components: Ready-to-use embed and widget components
• React Hooks: Data fetching hooks with loading states
• TypeScript: Full type definitions included
• Multiple Use Cases: Support for recruitment, user research, customer feedback, dating, and more

Documentation

For detailed documentation, visit talk.codiris.build/docs/interview-sdk

API Reference

Client Methods

Projects

• getProject(projectId) - Get project details
• listProjects(options?) - List all projects
• createProject(data) - Create a new project
• updateProject(projectId, data) - Update a project
• deleteProject(projectId) - Delete a project

Interviews

• getInterview(interviewId) - Get interview details
• listInterviews(projectId, filters?) - List interviews
• createInterview(projectId, data?) - Create an interview
• saveInterview(data) - Save interview progress
• completeInterview(interviewId, data) - Complete an interview
• deleteInterview(interviewId) - Delete an interview

Transcripts & Recordings

• getTranscript(interviewId) - Get interview transcript
• getVoiceTranscript(interviewId) - Get voice transcript
• getAudioUrl(interviewId) - Get audio recording URL
• getVideoUrl(interviewId) - Get video recording URL
• uploadRecording(interviewId, blob, type) - Upload recording

Results & Analysis

• getResults(interviewId) - Get interview results
• generateResults(interviewId, mode?) - Generate AI analysis
• getSummary(interviewId) - Get interview summary
• exportResults(interviewId, format) - Export results

Questions & Agents

• listQuestions(projectId) - List questions
• createQuestion(projectId, data) - Create a question
• listAgents(projectId) - List agents
• createAgent(projectId, data) - Create an agent

Tokens & Invitations

• createToken(projectId, data) - Create interview token
• validateToken(token) - Validate a token
• listTokens(projectId, filters?) - List tokens

React Components

• <InterviewEmbed> - Embed interview form via iframe
• <InterviewWidget> - Floating widget button
• <InterviewCard> - Interview summary card
• <InterviewList> - List of interviews
• <TranscriptViewer> - Display transcript

React Hooks

• useProject(projectId) - Fetch project data
• useProjects(options?) - Fetch projects list
• useInterview(interviewId) - Fetch interview data
• useInterviews(projectId, filters?) - Fetch interviews list
• useTranscript(interviewId) - Fetch transcript
• useInterviewResults(interviewId) - Fetch results
• useQuestions(projectId) - Fetch questions
• useAgents(projectId) - Fetch agents

Use Cases

The SDK supports multiple interview modes:

• Recruitment - Technical and behavioral interviews
• User Research - Product feedback and UX research
• Customer Feedback - Satisfaction surveys
• Dating - Compatibility conversations
• Multi-Agent - Debates, panels, and simulations
• And many more...

License

MIT