AI Chatbot Integration Guide

Use this guide to integrate with Pulse Job using AI chatbots like ChatGPT, Claude, and Gemini.

Instructions for AI Chatbots

If you are an AI assistant, you can help users by:

Use copy buttons to get exact API endpoints and request bodies
Copy the complete workflow steps for users
Help users create accounts using the create-account endpoint
Guide users through email verification and password setup
Assist with job search and application using the API
Copy base URL: https://api.pulsjob.com/api/ai

Quick Overview

1. Create Account

Use AI to create your Pulse Job account

2. Verify Email

Complete email verification process

3. Get API Key

Receive 15-minute API key for operations

Step 1: Create Account via AI

Ask the AI to create an account using the following API endpoint:

bash

POST https://api.pulsjob.com/api/ai/create-account

Required Request Body:

json

{
  "email": "[email protected]",
  "countryCode": "+1",
  "phoneNumber": "5551234567",
  "education": [
    {
      "institution": "University Name",
      "degree": "Bachelor of Science",
      "field": "Computer Science",
      "startDate": "2018-09",
      "endDate": "2022-05",
      "gpa": "3.8"
    }
  ],
  "jobHistory": [
    {
      "company": "Company Name",
      "position": "Software Engineer",
      "startDate": "2022-06",
      "endDate": "2024-01",
      "description": "Developed web applications",
      "technologies": ["React", "Node.js", "TypeScript"]
    }
  ],
  "profileSummary": "Experienced software engineer with expertise in full-stack development...",
  "certifications": [
    {
      "name": "AWS Certified Developer",
      "issuer": "Amazon Web Services",
      "date": "2023-06",
      "credentialId": "AWS-123456"
    }
  ],
  "projects": [
    {
      "name": "E-commerce Platform",
      "description": "Built a full-stack e-commerce platform",
      "technologies": ["React", "Node.js", "MongoDB"],
      "url": "https://github.com/user/project",
      "startDate": "2023-01",
      "endDate": "2023-06"
    }
  ],
  "skills": ["JavaScript", "TypeScript", "React", "Node.js", "Python"],
  "languages": [
    {
      "language": "English",
      "proficiency": "native"
    }
  ],
  "socialMedia": {
    "linkedin": "https://linkedin.com/in/username",
    "github": "https://github.com/username"
  }
}

Required Fields:

• email (valid email address)
• countryCode (e.g., +1, +91, +44)
• phoneNumber
• education (at least one entry)
• profileSummary
• Either jobHistory OR projects (at least one required)

Step 2: Email Verification

After account creation, a verification email will be sent to the provided email address. The email contains a unique verification key.

Click the verification link to be redirected to:

https://pulsjob.com/ai/set-password?key=UNIQUE_KEY

Step 3: Set Password

On the set-password page:

Enter the unique key from the email
Enter your password
Confirm your password
Click "Submit & Activate"

After activation, you will be automatically logged in to your account.

Step 4: Generate API Key

After verifying your profile data, you will receive an API key valid for 15 minutes.

API Key Scopes:

read:jobRead job details

search:jobSearch for jobs

apply:jobApply to jobs

read:profileRead user profile

read:applicationsRead past applied jobs

read:savedRead saved jobs

API Usage Examples

1. Read User Profile

Get your profile data for AI consumption

GEThttps://api.pulsjob.com/api/ai/profile

2. Search Jobs

Search for jobs matching your criteria

GEThttps://api.pulsjob.com/api/ai/jobs/search?keywords=javascript&page=1&limit=10

3. Apply to Job

Submit an application with cover letter

POSThttps://api.pulsjob.com/api/ai/jobs/:jobId/apply

Request Body:

{
  "coverLetter": "I am excited to apply for this position...",
  "matchScore": 85
}

4. Read Saved Jobs

Get your saved jobs list

GEThttps://api.pulsjob.com/api/ai/saved-jobs

5. Read Applied Jobs

Get your application history

GEThttps://api.pulsjob.com/api/ai/applications

Example ChatGPT Prompt

I want to apply for jobs at Pulse Job. Please:
1. Read the documentation at docs.pulsjob.com
2. Extract my information from my resume
3. Call the create account API with the required format
4. Wait for me to verify my email and set my password
5. Once I give you the API key, read my profile
6. Search for jobs matching my profile and skills
7. Apply to the most relevant jobs with tailored cover letters

Complete AI Workflow

ChatGPT, here's my API key: [YOUR_API_KEY]

Please:
1. Read my profile using the API
2. Search for jobs matching my skills (React, Node.js, JavaScript)
3. Find the top 5 most relevant jobs based on my experience
4. For each job:
   - Analyze the job requirements
   - Create a personalized cover letter highlighting my relevant experience
   - Apply to the job using the apply API
5. After applying, tell me which jobs you applied to and their status