openapi: 3.0.0 servers: - url: https://prod.api.market/api/v1/sharpapi.com/resume info: title: AI-Powered Resume/CV Parsing API description: Advanced AI-powered Resume/CV parsing version: 1.0.0 components: securitySchemes: {} paths: /api/v1/hr/parse_resume: post: tags: - default summary: Parse Resume/CV File description: >- Parses a resume (CV) file from multiple formats (PDF/DOC/DOCX/TXT/RTF) and returns an extensive object of data points. The file has to be uploaded as `form-data` parameter called `file`. An optional language parameter can also be provided (\`English\` value is set as the default one) . RESULT EXAMPLE: ``` json { "data": { "type": "api_job_result", "id": "09cf83f8-3e3e-4948-add9-63cdecc1f9fe", "attributes": { "status": "success", "type": "hr_parse_resume", "result": { "candidate_name": "Linda Harris", "candidate_email": "linda.h@dayjob.co.uk", "candidate_phone": "02476 000 0000, 0887 222 9999", "candidate_address": "34 Made Up Road, Coventry, CV66 7RF", "candidate_language": "English", "candidate_spoken_languages": [ "German" ], "candidate_honors_and_awards": [], "candidate_courses_and_certifications": [ "ISEB certification" ], "positions": [ { "position_name": "Test Engineer", "company_name": "IT & Telecoms Company", "country": "United Kingdom", "start_date": "2008-06-01", "end_date": null, "skills": [ "Acceptance testing", "Technical investigation", "Exploratory testing", "Agile", "Test environments", "Test management tools", "UAT knowledge", "Writing test reports", "Organising test activities", "Performance testing", "Integration testing", "Equipment failure response", "Audits and reviews", "Monitoring repair trends", "Documentation updates", "Executing test cases", "Testing and fault finding", "Reporting issues", "Software installation", "Problem solving", "Testing Web software", "Testing PC software", "Testing mobile software", "Manual testing methods", "Test Systems hardware and software" ], "job_details": "Responsible for the whole test process from planning, through test plan development, execution & result reporting. Also involved in the development and improvement of the test functions, putting forward suggestions and implementing plans accordingly. Duties included organising, conducting and supporting test activities, performance testing, integration testing, responding to equipment failures, participating in audits and reviews, monitoring repair trends, updating documentation, executing test cases, testing and fault finding finished systems, reporting issues to the Test Manager, and assisting in software installation." } ], "education_qualifications": [ { "school_name": "Nuneaton University", "school_type": "University or equivalent", "degree_type": "Bachelor’s Degree or equivalent", "faculty_department": "", "specialization_subjects": "Information Technology (Software Engineering)", "country": "United Kingdom", "start_date": "2005-01-01", "end_date": "2008-01-01", "learning_mode": "In-person learning", "education_details": "" }, { "school_name": "Coventry North School", "school_type": "High School/Secondary School or equivalent", "degree_type": "High School/Secondary School Diploma or equivalent", "faculty_department": "", "specialization_subjects": "", "country": "United Kingdom", "start_date": "2000-01-01", "end_date": "2005-01-01", "learning_mode": "In-person learning", "education_details": "A levels: Maths (A), English (B), Technology (B), Science (C)" } ] } } } } ``` requestBody: content: multipart/form-data: schema: type: object properties: file: type: string format: binary language: type: string example: English security: - bearerAuth: [] parameters: - name: Accept in: header schema: type: string example: application/json responses: "202": description: Accepted headers: Date: schema: type: string example: Wed, 10 Jul 2024 18:34:19 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive Location: schema: type: string example: https://sharpapi.com/api/v1/hr/parse_resume/job/status/09cf83f8-3e3e-4948-add9-63cdecc1f9fe Cache-Control: schema: type: string example: no-cache, private X-RateLimit-Limit: schema: type: integer example: "1000" X-RateLimit-Remaining: schema: type: integer example: "999" Access-Control-Allow-Origin: schema: type: string example: "*" Server: schema: type: string example: A2Z WEB Server content: application/json: schema: type: object example: status_url: https://sharpapi.com/api/v1/hr/parse_resume/job/status/09cf83f8-3e3e-4948-add9-63cdecc1f9fe job_id: 09cf83f8-3e3e-4948-add9-63cdecc1f9fe "401": description: Unauthorized headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Sun, 19 Nov 2023 16:44:03 GMT X-RateLimit-Limit: schema: type: integer example: "100" X-RateLimit-Remaining: schema: type: integer example: "98" phpdebugbar-id: schema: type: string example: X0f64d3f8b52459b75751d7a6af2d0b07 Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: error: message: Unauthorized "402": description: Payment Required headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Tue, 02 Jan 2024 07:03:29 GMT X-RateLimit-Limit: schema: type: integer example: "100" X-RateLimit-Remaining: schema: type: integer example: "99" phpdebugbar-id: schema: type: string example: Xf00ad555ebc896d53b8b08f113f921c6 Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: code: GEN-PAYMENT-REQUIRED message: You have exceeded your monthly words quota [1694]. Please login to the dashboard and increase number of credits. "422": description: Unprocessable Content headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Sun, 19 Nov 2023 16:43:25 GMT X-RateLimit-Limit: schema: type: integer example: "100" X-RateLimit-Remaining: schema: type: integer example: "99" phpdebugbar-id: schema: type: string example: X1ed69b2f49ae980f30cd58f34a20e55b Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: message: The file field is required. errors: file: - The file field is required. "429": description: Too Many Requests headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 X-RateLimit-Limit: schema: type: integer example: "10" X-RateLimit-Remaining: schema: type: integer example: "0" Retry-After: schema: type: integer example: "36" X-RateLimit-Reset: schema: type: integer example: "1704178455" Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Tue, 02 Jan 2024 06:53:39 GMT phpdebugbar-id: schema: type: string example: X9f2181464b51be9e9be7f7dc51f8f466 Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: message: Too Many Attempts. "500": description: Internal Server Error headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Tue, 02 Jan 2024 07:25:48 GMT phpdebugbar-id: schema: type: string example: X517907651764444b8177406b21fb8a01 Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: message: Server Error "503": description: Service Unavailable headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Tue, 02 Jan 2024 07:30:47 GMT Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: message: Service Unavailable parameters: - &a1 description: API.market API Key in: header name: x-api-market-key value: Please Login/Signup to get an API Key required: true schema: type: string /api/v1/hr/parse_resume/job/status/{uuid}: get: tags: - default summary: Job Status/Result description: >- An endpoint is used to check on the progress of the requested API job. RESULT EXAMPLE: ``` json { "data": { "type": "api_job_result", "id": "09cf83f8-3e3e-4948-add9-63cdecc1f9fe", "attributes": { "status": "success", "type": "hr_parse_resume", "result": { "candidate_name": "Linda Harris", "candidate_email": "linda.h@dayjob.co.uk", "candidate_phone": "02476 000 0000, 0887 222 9999", "candidate_address": "34 Made Up Road, Coventry, CV66 7RF", "candidate_language": "English", "candidate_spoken_languages": [ "German" ], "candidate_honors_and_awards": [], "candidate_courses_and_certifications": [ "ISEB certification" ], "positions": [ { "position_name": "Test Engineer", "company_name": "IT & Telecoms Company", "country": "United Kingdom", "start_date": "2008-06-01", "end_date": null, "skills": [ "Acceptance testing", "Technical investigation", "Exploratory testing", "Agile", "Test environments", "Test management tools", "UAT knowledge", "Writing test reports", "Organising test activities", "Performance testing", "Integration testing", "Equipment failure response", "Audits and reviews", "Monitoring repair trends", "Documentation updates", "Executing test cases", "Testing and fault finding", "Reporting issues", "Software installation", "Problem solving", "Testing Web software", "Testing PC software", "Testing mobile software", "Manual testing methods", "Test Systems hardware and software" ], "job_details": "Responsible for the whole test process from planning, through test plan development, execution & result reporting. Also involved in the development and improvement of the test functions, putting forward suggestions and implementing plans accordingly. Duties included organising, conducting and supporting test activities, performance testing, integration testing, responding to equipment failures, participating in audits and reviews, monitoring repair trends, updating documentation, executing test cases, testing and fault finding finished systems, reporting issues to the Test Manager, and assisting in software installation." } ], "education_qualifications": [ { "school_name": "Nuneaton University", "school_type": "University or equivalent", "degree_type": "Bachelor’s Degree or equivalent", "faculty_department": "", "specialization_subjects": "Information Technology (Software Engineering)", "country": "United Kingdom", "start_date": "2005-01-01", "end_date": "2008-01-01", "learning_mode": "In-person learning", "education_details": "" }, { "school_name": "Coventry North School", "school_type": "High School/Secondary School or equivalent", "degree_type": "High School/Secondary School Diploma or equivalent", "faculty_department": "", "specialization_subjects": "", "country": "United Kingdom", "start_date": "2000-01-01", "end_date": "2005-01-01", "learning_mode": "In-person learning", "education_details": "A levels: Maths (A), English (B), Technology (B), Science (C)" } ] } } } } ``` security: - bearerAuth: [] parameters: - name: Accept in: header schema: type: string example: application/json - name: uuid in: path schema: type: string required: true description: UUID of the dispatched job example: 09cf83f8-3e3e-4948-add9-63cdecc1f9fe responses: "200": description: OK headers: Date: schema: type: string example: Wed, 10 Jul 2024 18:33:08 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive Vary: schema: type: string example: Accept-Encoding SharpAPI-Cost: schema: type: number example: "0.0000" Cache-Control: schema: type: string example: no-cache, private X-RateLimit-Limit: schema: type: integer example: "1000" X-RateLimit-Remaining: schema: type: integer example: "998" Access-Control-Allow-Origin: schema: type: string example: "*" Server: schema: type: string example: A2Z WEB Server Content-Encoding: schema: type: string example: gzip content: application/json: schema: type: object examples: example-0: summary: 200 OK value: data: type: api_job_result id: 87eda824-6b9e-4557-b5e0-fa23b2207d58 attributes: status: success type: hr_parse_resume result: candidate_name: Linda Harris candidate_email: linda.h@dayjob.co.uk candidate_phone: 02476 000 0000, 0887 222 9999 candidate_address: 34 Made Up Road, Coventry, CV66 7RF candidate_language: English candidate_spoken_languages: - German candidate_honors_and_awards: [] candidate_courses_and_certifications: - ISEB certification positions: - position_name: Test Engineer company_name: IT & Telecoms Company country: United Kingdom start_date: 2008-06-01 end_date: null skills: - Acceptance testing - Technical investigation - Exploratory testing - Agile - Test environments - Test management tools - UAT knowledge - Writing test reports - Organising test activities - Performance testing - Integration testing - Equipment failure response - Audits and reviews - Monitoring repair trends - Documentation updates - Executing test cases - Testing and fault finding - Reporting issues - Software installation - Problem solving - Testing Web software - Testing PC software - Testing mobile software - Manual testing methods - Test Systems hardware and software job_details: Responsible for the whole test process from planning, through test plan development, execution & result reporting. Also involved in the development and improvement of the test functions, putting forward suggestions and implementing plans accordingly. Duties included organising, conducting and supporting test activities, performance testing, integration testing, responding to equipment failures, participating in audits and reviews, monitoring repair trends, updating documentation, executing test cases, testing and fault finding finished systems, reporting issues to the Test Manager, and assisting in software installation. education_qualifications: - school_name: Nuneaton University school_type: University or equivalent degree_type: Bachelor’s Degree or equivalent faculty_department: "" specialization_subjects: Information Technology (Software Engineering) country: United Kingdom start_date: 2005-01-01 end_date: 2008-01-01 learning_mode: In-person learning education_details: "" - school_name: Coventry North School school_type: High School/Secondary School or equivalent degree_type: High School/Secondary School Diploma or equivalent faculty_department: "" specialization_subjects: "" country: United Kingdom start_date: 2000-01-01 end_date: 2005-01-01 learning_mode: In-person learning education_details: "A levels: Maths (A), English (B), Technology (B), Science (C)" example-1: summary: 200 Pending job value: data: type: api_job id: 910abc73-66ec-4349-9fd3-faabaf37d240 attributes: status: pending type: hr_parse_resume example-2: summary: 200 Failed Job value: data: type: api_job id: b08a921f-aaa0-43d9-be08-e4921d41ef34 attributes: status: failed type: ecommerce_product_categories "401": description: Unauthorized headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Sun, 19 Nov 2023 16:27:43 GMT X-RateLimit-Limit: schema: type: integer example: "100" X-RateLimit-Remaining: schema: type: integer example: "99" phpdebugbar-id: schema: type: string example: X8d4d9839c30af00c0675570c228f69c9 Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: error: message: Unauthorized "402": description: Payment Required headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Tue, 02 Jan 2024 06:34:29 GMT X-RateLimit-Limit: schema: type: integer example: "100" X-RateLimit-Remaining: schema: type: integer example: "99" phpdebugbar-id: schema: type: string example: X6c81c005f0f705cca5885f99fff295d7 Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: code: GEN-PAYMENT-REQUIRED message: You have exceeded your monthly words quota [297]. Please login to the dashboard and increase number of credits. "404": description: Not Found headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Sun, 19 Nov 2023 16:23:46 GMT X-RateLimit-Limit: schema: type: integer example: "100" X-RateLimit-Remaining: schema: type: integer example: "97" phpdebugbar-id: schema: type: string example: X251e2f97d6a9d1de4ae3c6577faa076c Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: code: GEN-NOT-FOUND message: Resource Not Found "429": description: Too Many Requests headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 X-RateLimit-Limit: schema: type: integer example: "10" X-RateLimit-Remaining: schema: type: integer example: "0" Retry-After: schema: type: integer example: "26" X-RateLimit-Reset: schema: type: integer example: "1704178189" Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Tue, 02 Jan 2024 06:49:23 GMT phpdebugbar-id: schema: type: string example: Xe68c3b718e9258aaee80fc4de259a467 Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: message: Too Many Attempts. "500": description: Internal Server Error headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Sun, 19 Nov 2023 16:29:09 GMT phpdebugbar-id: schema: type: string example: X129712dd4a997e6fce6919950cf5b29c Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: message: Server Error "503": description: Service Unavailable headers: Server: schema: type: string example: nginx Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive X-Powered-By: schema: type: number example: PHP/8.2.10 Cache-Control: schema: type: string example: no-cache, private Date: schema: type: string example: Tue, 02 Jan 2024 07:30:20 GMT Access-Control-Allow-Origin: schema: type: string example: "*" content: application/json: schema: type: object example: message: Service Unavailable parameters: - *a1 security: {} tags: - name: resume-parsing description: Operations related to resume-parsing - name: job-search description: Operations related to job-search - name: job-listings description: Operations related to job-listings