Job
Job · Ações GPT
Job Search and Query Parsing API
APIs for parsing search queries and searching jobs
POST /swan/gpts/oneline/parseParseSearchPreferenceParse user's search preference
GET /swan/gpts/daily-briefGetDailyBriefGet today's job market information on a particular job title or some default popular job titles
GET /swan/gpts/job/search/companyCompanyInfoSearchFetch extensive information about a company
POST /swan/gpts/job/search/dailyJobSearchSearch for jobs based on various filters
Esquema API original
{
"openapi": "3.1.0",
"info": {
"title": "Job Search and Query Parsing API",
"description": "APIs for parsing search queries and searching jobs",
"version": "v1.0.0"
},
"servers": [
{
"url": "https://swan-api.jobright.ai"
}
],
"components": {
"schemas": {
"FilterCondition": {
"type": "object",
"properties": {
"jobTitle": {
"type": "string"
},
"jobTypes": {
"type": "array",
"items": {
"type": "integer"
}
},
"city": {
"type": "string",
"nullable": true
},
"seniority": {
"type": "array",
"items": {
"type": "integer"
}
},
"companyCategory": {
"type": "array",
"items": {
"type": "string"
}
},
"annualSalaryMinimum": {
"type": "integer",
"nullable": true
},
"isH1BOnly": {
"type": "boolean"
},
"roleType": {
"type": "string",
"nullable": true
},
"skills": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"companyStages": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"workModel": {
"type": "array",
"items": {
"type": "integer"
}
},
"radiusRange": {
"type": "number",
"format": "float"
},
"daysAgo": {
"type": "integer",
"description": "default to 1, represents jobs within 1 day (24 hours)",
"nullable": true
}
}
}
}
},
"paths": {
"/swan/gpts/oneline/parse": {
"post": {
"description": "Parse user's search preference",
"operationId": "ParseSearchPreference",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"oneLineInput": {
"type": "string",
"description": "One sentence input from user to describe the job search preference"
},
"visitId": {
"type": "string",
"description": "An ID to identify user's identity, can hardcode to '1024' for now"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates if the request was successful"
},
"errorCode": {
"type": "integer",
"description": "Error code, 10000 for success"
},
"errorMsg": {
"type": "string",
"description": "Error message if applicable"
},
"result": {
"type": "object",
"description": "Filter conditions returned by the server",
"properties": {
"filterResult": {
"$ref": "#/components/schemas/FilterCondition"
}
}
}
}
}
}
}
}
}
}
},
"/swan/gpts/daily-brief": {
"get": {
"description": "Get today's job market information on a particular job title or some default popular job titles",
"operationId": "GetDailyBrief",
"x-openai-isConsequential": false,
"parameters": [
{
"in": "query",
"name": "title",
"schema": {
"type": "string"
},
"required": false,
"description": "Optional job title. If it's present, the result will be daily brief regarding that job title, otherwise, it will be regard to default popular job titles such as software engineer, product manager etc."
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Indicates if the request was successful"
},
"errorCode": {
"type": "integer",
"description": "Error code, 10000 for success"
},
"errorMsg": {
"type": "string",
"description": "Error message if applicable"
},
"result": {
"type": "object",
"description": "Brief information about job markets in last 24 hours",
"properties": {
"popularJobs": {
"type": "object",
"description": "A dictionary from job titles to their related job counts"
},
"popularCompanies": {
"type": "object",
"description": "A dictionary from fortune 500 companies to job counts that they published"
},
"jobsByIndustries": {
"type": "object",
"description": "A dictionary from industries to their related job counts"
},
"jobsBySeniority": {
"type": "object",
"description": "A dictionary from seniority levels to their corresponding job counts"
}
}
}
}
}
}
}
}
}
}
},
"/swan/gpts/job/search/company": {
"get": {
"description": "Fetch extensive information about a company",
"operationId": "CompanyInfoSearch",
"x-openai-isConsequential": false,
"parameters": [
{
"in": "query",
"name": "name",
"required": true,
"schema": {
"type": "string"
},
"description": "The name of the company to search for"
}
],
"responses": {
"200": {
"description": "Successful response with company information",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"errorCode": {
"type": "integer"
},
"errorMsg": {
"type": "string"
},
"result": {
"type": "object",
"properties": {
"c_category_list": {
"type": "string",
"description": "List of categories that the company belongs to"
},
"c_city": {
"type": "string"
},
"c_employee_count": {
"type": "string",
"description": "Number of employees"
},
"c_facebook_url": {
"type": "string"
},
"c_founded_on": {
"type": "string"
},
"c_fund_raising": {
"type": "array",
"items": {
"type": "object",
"description": "Details of the company's fundraising rounds including date, type, number of investors, amount in USD, post-money valuation and lead investor"
},
"description": "Details of the company's fundraising rounds"
},
"c_homepage_url": {
"type": "string"
},
"c_leadership": {
"type": "array",
"description": "Information about the company's leadership team",
"items": {
"type": "object",
"description": "Information about each leadership team member including name, title, tenure, and social media links"
}
},
"c_press_references": {
"type": "array",
"description": "Press references about the company",
"items": {
"type": "object",
"description": "Details of press articles including the title, URL, publisher, and date of posting"
}
},
"c_short_description": {
"type": "string",
"description": "Short description of the company"
},
"c_total_funding_usd": {
"type": "string",
"description": "Total funding received by the company in USD"
},
"g_rating": {
"type": "object",
"description": "Glassdoor rating of the company including the overall rating, number of ratings, and a link to the Glassdoor page"
},
"h1b_annual_job_count": {
"type": "array",
"description": "Annual H-1B sponsorship count by the company",
"items": {
"type": "object",
"description": "Annual H-1B sponsorship count by the company, including the year and number of sponsorships"
}
},
"h1b_title_distribution": {
"type": "array",
"description": "Job functions that had H-1B sponsorship by the company",
"items": {
"type": "object",
"description": "Distribution of job functions that received H-1B sponsorship, including the title and count"
}
}
}
}
}
}
}
}
}
}
}
},
"/swan/gpts/job/search/daily": {
"post": {
"description": "Search for jobs based on various filters",
"operationId": "JobSearch",
"x-openai-isConsequential": false,
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"startPos": {
"type": "integer",
"description": "The starting position for the search results. This parameter could be for simple pagination, for example, if user has seen 20 jobs, you can set startPos to 20 for next batch of jobs."
},
"sortCondition": {
"type": "string",
"description": "The condition used for sorting the search results. RELEVANCE is the default value which means sort by relevance, FRESHNESS is sorting by fresheness so that fresh jobs will go first."
},
"filterCondition": {
"$ref": "#/components/schemas/FilterCondition"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful job search response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"results": {
"type": "array",
"description": "array of jobs",
"items": {
"type": "object",
"properties": {
"jobResult": {
"type": "object",
"properties": {
"jobTitle": {
"type": "string"
},
"jobSeniority": {
"type": "string"
},
"jobLocation": {
"type": "string"
},
"isRemote": {
"type": "boolean"
},
"workModel": {
"type": "string"
},
"publishTime": {
"type": "string"
},
"publishTimeDesc": {
"type": "string"
},
"salaryDesc": {
"type": "string"
},
"employmentType": {
"type": "string"
},
"jobSummary": {
"type": "string"
},
"url": {
"type": "string"
},
"applyLink": {
"type": "string"
},
"h1BStatus": {
"type": "string",
"description": "Either Past Sponsorship or Explicit mentioned"
}
}
},
"companyResult": {
"type": "object",
"properties": {
"companyName": {
"type": "string"
},
"companySize": {
"type": "string"
},
"companyDesc": {
"type": "string"
},
"companyCategories": {
"type": "string"
},
"companyURL": {
"type": "string"
},
"fundraisingCurrentStage": {
"type": "string"
},
"fundraisingTotalFunding": {
"type": "string"
},
"grating": {
"type": "object",
"description": "glassdoor rating"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}