Developer Documentation

Build with JobInst API

Integrate AI-powered career tools into your applications with our comprehensive API. Help users optimize resumes, generate cover letters, and accelerate their career growth.

Quick Start

Get up and running with the JobInst API in minutes

1

Get Your API Key

Sign up for a JobInst account and generate your API key from the dashboard.

JavaScript
// Get your API key from https://app.jobinst.com/api-keys
const API_KEY = 'your_api_key_here';
2

Make Your First Request

Use our REST API to optimize a resume or generate a cover letter.

JavaScript
fetch('https://api.jobinst.com/v1/resume/optimize', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + API_KEY,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    resume_text: 'Your resume content...',
    job_description: 'Target job description...'
  })
});
3

Handle the Response

Process the optimized content and integrate it into your application.

JavaScript
.then(response => response.json())
.then(data => {
  console.log('Optimized resume:', data.optimized_resume);
  console.log('ATS score:', data.ats_score);
  console.log('Suggestions:', data.suggestions);
});

API Reference

Complete reference for all available endpoints

POST/v1/resume/optimize

Optimize resume content for specific job descriptions

Parameters:

resume_textjob_descriptiontarget_role
POST/v1/cover-letter/generate

Generate personalized cover letters

Parameters:

job_descriptioncompany_nameuser_experience
POST/v1/interview/prepare

Get interview questions and suggested answers

Parameters:

job_descriptionexperience_levelquestion_count
POST/v1/salary/analyze

Analyze salary ranges and negotiation strategies

Parameters:

job_titlelocationexperience_years
GET/v1/skills/trending

Get trending skills for specific industries

Parameters:

industrylocationtime_period
POST/v1/career/pivot

Analyze career transition opportunities

Parameters:

current_roletarget_industryskills

Code Examples

Real-world examples to get you started quickly

Resume Optimization

JavaScript
const optimizeResume = async (resumeText, jobDescription) => {
  const response = await fetch('https://api.jobinst.com/v1/resume/optimize', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer ' + API_KEY,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      resume_text: resumeText,
      job_description: jobDescription,
      target_role: 'Software Engineer'
    })
  });
  
  const result = await response.json();
  return result;
};

Cover Letter Generation

Python
import requests

def generate_cover_letter(job_desc, company, experience):
    url = "https://api.jobinst.com/v1/cover-letter/generate"
    
    headers = {
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    }
    
    data = {
        "job_description": job_desc,
        "company_name": company,
        "user_experience": experience
    }
    
    response = requests.post(url, headers=headers, json=data)
    return response.json()

Interview Preparation

cURL
curl -X POST https://api.jobinst.com/v1/interview/prepare \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "job_description": "Senior React Developer position...",
    "experience_level": "senior",
    "question_count": 10
  }'

SDKs & Libraries

Official libraries and tools to accelerate your development

JavaScript SDK

Official JavaScript/TypeScript SDK for web applications

npm install @jobinst/sdk
View on GitHub

Python Library

Python client library for server-side integrations

pip install jobinst-python
View on GitHub

React Components

Pre-built React components for quick integration

npm install @jobinst/react
View on GitHub

REST API

Direct HTTP API access for any programming language

No installation required
View on GitHub

Developer Guides

In-depth tutorials and best practices

Getting Started Guide

Complete walkthrough for new developers

  • Account Setup
  • API Authentication
  • First Integration
  • Best Practices

API Reference

Detailed documentation for all endpoints

  • Authentication
  • Request/Response Format
  • Error Codes
  • Rate Limits

Integration Examples

Real-world implementation examples

  • JavaScript SDK
  • Python Library
  • React Components
  • Node.js Server

Advanced Features

Webhooks, batch processing, and more

  • Webhooks
  • Batch Operations
  • Custom Models
  • Analytics

Need Help Getting Started?

Our developer support team is here to help you integrate the JobInst API into your applications.