SJM API Reference

SJM provides a comprehensive REST API that enables you to match freelancers to projects, verify skills, conduct AI-powered interviews, and more. This documentation covers all available endpoints, their parameters, and response formats.

Core Endpoints

The SJM API is organized around REST principles. All requests should be made to the base URL https://snapjobsai.com/api/v1 and must include your API key in the X-API-Key header.

SnapJobs API Playground

match Parameters

Response

Run the API test to see results

Visit SnapJobs Sandbox for more flexible tests!

Authentication

All API requests require authentication using an API key. Include your API key in the request headers:

curl -X POST https://snapjobsai.com/api/v1/match \
-H "X-API-Key: your_api_key" \
-H "Content-Type: application/json"

To obtain an API key, obtain one at https://snapjobsai.com/dashboard.

Rate Limiting

The API implements rate limiting based on your plan:

| Plan | Requests per minute | |---------------|--------------------| | Free | 100 | | Professional | 1000 | | Enterprise | Unlimited |

Rate limit information is included in the response headers:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 995
X-RateLimit-Reset: 3600

Response Format

All responses follow a standard format:

{
"status": "success",
"data": { ... }
}

Endpoints

Health Check

Check the health status of the API.

curl -X GET https://snapjobsai.com/api/v1/health \
-H "X-API-Key: your_api_key"

Match Freelancers

Match freelancers to a project based on skills, budget, and other parameters.

{
"description": "Build a modern web application with React and Node.js",
"required_skills": ["React.js", "Node.js", "TypeScript"],
"budget_range": [5000, 10000],
"complexity": "medium",
"timeline": 30
}