Get access to the PoweredBy REST API
Get PoweredBy API key
PoweredBy supports API key authentication. Follow these steps to obtain API key and include in your requests:
Accessing API Keys:
- Navigate to the "API Keys" section by selecting the "API Keys" tab in the left navigation bar.
Generating a New API Key:
- Within the "API Keys" section, click on the "Generate a New API Key" option.
- Confirm the action when prompted.
Locating the Generated API Key:
- The newly generated API key will be automatically added to the top of the existing list.
Authentication in API Calls:
- Copy the recently generated API key for authentication in your API calls.
Including API Key in Headers:
- Insert the copied API key into the headers of your HTTP requests.
- Use the Authorization header in your HTTP requests and include the API key, as illustrated in the following snippet:
GET /your-endpoint HTTP/1.1
Host: api.startdate.co
"X-POWEREDBY-API-KEY": Bearer sd_apik_587eba9af8ab45baa094703c1b7f9dd1
Make a REST call to PoweredBy Request
Create a Post PoweredBy request using api key in request headers. Include the given request body in Form Data to screen the resumes.
Request URL:
POST https://api.startdate.co/api/v1/powered_by/screenRequest Headers:
Content-Type: multipart/form-data
"X-POWEREDBY-API-KEY": Bearer sd_apik_587eba9af8ab45baa094703c1b7f9dd1Request Body (Form Data):
- `resumes`: (Mandatory) Attach the resume files.
- `job_description`: (Mandatory) Enter the job description.
- `job_title`: (Mandatory) Enter the job title.
- `skills`: (Mandatory) Enter the required job skills.
- `model`: (Optional) Specify the model option (options: sd_v4 | sd_v5 | openai_3.5).
Example cURL Request:
curl -X POST
https://api.startdate.co/api/v1/powered_by/screen
-H 'Content-Type: multipart/form-data'
-H 'Authorization: Bearer your-api-key'
-F 'resumes=@/path/to/resume1.pdf'
-F 'resumes=@/path/to/resume2.docx'
-F 'job_description=Enter job description'
-F 'job_title=Enter job title'
-F 'skills=Enter job skills'
-F 'model=openai_3.5'Make sure to replace `your-api-key` with your actual API key and adjust the file paths accordingly in the cURL command. This example assumes you are using a tool like cURL to make the HTTP request.
Get PoweredBy Request
Below are the instructions for making a GET request to retrieve ranked resumes data based on the `powered_by_request_id` obtained from the POST request. Additionally, the request includes details about getting accuracy for each resume and skills insights:
Retrieve Ranked Resumes Data:
Request URL:
GET https://api.startdate.co/api/v1/powered_by/screen/<powered_by_request_id>Request Headers:
"X-POWEREDBY-API-KEY": Bearer sd_apik_587eba9af8ab45baa094703c1b7f9dd1Replace `powered_by_request_id` with the actual `powered_by_request_id` obtained from the POST request.
Example cURL Request:
curl -X GET
https://api.startdate.co/api/v1/powered_by/screen/<powered_by_request_id>
-H "X-POWEREDBY-API-KEY": Bearer sd_apik_587eba9af8ab45baa094703c1b7f9dd1Get Accuracy for Each Resume and Skills Insights:
Upon receiving the response from the GET request, you can extract information about accuracy for each resume and skills insights. The specific structure of the response will depend on the API, but typically you might find this information in the response body.
Here's a general example of how you might parse the response in a hypothetical scenario:
{
"id": "c55146c2-4300-47f1-8003-0d9e0f70853c",
"request_status": "Completed",
"request_body": {
"job_posting": {
"title": "Developer",
"skills": "avaScript, ReactJS, C#",
"description": "Undertook the responsibility of redeveloping projects by transitioning from web
forms to ReactJS and .NET Core.
• Played a pivotal role in identifying and resolving core issues to enhance the
usability and functionality of the product.
• Collaborated closely with the development team to ensure seamless integration of
the new tech stack and minimize any disruption to ongoing projects.
• Contributed to the improvement of overall project efficiency and performance by
implementing industry best practices and optimizing code."
}
},
"resumes_status": [
{
"id": "2ba17b68-5b02-4cd4-b148-6c3c17f32901",
"resume": "ab.pdf",
"status": "Success"
},
{
"id": "1dda3f73-fc23-44db-a14d-5c2f567c738c",
"resume": "cd.pdf",
"status": "Success"
}
],
"screening_response": [{
"id": "2ba17b68-5b02-4cd4-b148-6c3c17f32901",
"email": "357@gmail.com",
"phone": "354957966",
"skills": [
{
"skill": "MS Office"
},
{
"skill": "SAP"
},
{
"skill": "Zoho CRM"
}
],
"address": {
"city": "hyderabad",
"state": "telangana",
"country": "india",
"zip-code": "502032"
},
"summary": "Expert in Sales and Order processing bringing 5 years of experience. Effectively manages assignments and team members. Dedicated to self-development to provide expectation-exceeding service. Dedicating with my experience in achieving tangible results and cross-team collaboration. Proactive and excited to partner with like-minded individuals to achieve goals.",
"accuracy": 0.14956603990867734,
"last_name": "avani",
"first_name": "kuaku",
"open_ai_cost": 0.0052765,
"work_history": [
{
"title": "sales co-ordinator",
"company": "microgenesis cadsoft pvt ltd",
"to_date": " ",
"from_date": " ",
"description": "working as sales co-ordinator in terms of customer relationship management. maintaining the retention business of customer as per their requirement without losing the deal. order processing through zoho crm like creating opportunity, quotations & sales. sharing the invoices and updating sheets. sales through cold calls, guiding the customers for retinting and upsell."
},
{
"title": "sales executive",
"company": "tata croma retail",
"to_date": " ",
"from_date": " ",
"description": "worked as sales executive in terms of customer service specialist. well known with billing, cash handling, tender codes and declaration of the day end. also learned backend process like back dock controller into inventory, stock keeping and management with excess and contra inward, outward of goods data maintaining in sap. expert in providing the service within the tat of active gan."
}
],
"education_history": [
{
"name": "manjeera degree & pg college",
"degree": "bachelor of commerce",
"to_date": "01-01-2022",
"from_date": "01-01-2019"
}
],
"total_openai_call": 5,
"recommended_skills": [
{
"skill": "MS Office",
"accuracy": 33
},
{
"skill": "SAP",
"accuracy": 33
},
{
"skill": "Zoho CRM",
"accuracy": 25
}
]
},
{
"id": "3fc33232-b7e2-45e1-94e8-5963464da20b",
"email": "03k@gmail.com",
"phone": "+91 9618269320",
"skills": [
{
"skill": "ability to work collaboratively in teams"
},
{
"skill": "problem-solving"
},
{
"skill": "clear communication"
},
{
"skill": "confident to work independently"
}
],
"address": {
"city": "hyderabad",
"state": "telangana",
"country": "india",
"zip-code": ""
},
"summary": "A highly enthusiastic individual with a passion and desire to grow in the field of business, I have always admired and enjoyed my roles from working internships to working as a Business Development Associate. I believe my ability to work collaboratively in teams, solve problems effectively, clear communication, confident to work independently has allowed me to be a great asset to the companies.",
"accuracy": 55.041807889938354,
"last_name": "sai",
"first_name": "k",
"open_ai_cost": 0.0055885,
"work_history": [
{
"title": "business development associate",
"company": "pinscale",
"to_date": "01-12-2024",
"from_date": "06-01-2023",
"description": "working as a business development associate for their product- iBCricket a VR Cricket Game. handle end-to-end execution of iB Cricket events to increase brand awareness, generate leads. attending conferences and summits, engaging in brand activations. ensuring a greater number of games are played and more revenue is generated by upselling the overs. travelling across cities for their events, ensure high participation and engagement. primarily focused on the sales of the home edition and their lead generation. ensure team improves performance, achieves targets."
},
{
"title": "operations intern",
"company": "offo store llp",
"to_date": "08-01-2022",
"from_date": "06-01-2022",
"description": "an e-commerce affordable gifting platform. reconstructed their website and listed around 100-150 products using shopify. handle and improve their e-commerce accounts. worked on strategies for giveaways and affiliate marketing. content creation for their products."
},
{
"title": "business development head",
"company": "searchresumes",
"to_date": "02-01-2022",
"from_date": "11-01-2021",
"description": "a new venture by simplifysolution that provides resumes and manpower. manage, train, and hire telecallers and interns. monitoring them, crm and ensuring the targets are achieved. conversion of possible leads."
}
],
"education_history": [
{
"name": "icfai university",
"degree": "bachelors of business administration",
"to_date": "01-01-2023",
"from_date": "01-01-2020"
}
],
"total_openai_call": 5,
"recommended_skills": [
{
"skill": "ability to work collaboratively in teams",
"accuracy": 50
},
{
"skill": "confident to work independently",
"accuracy": 48
},
{
"skill": "clear communication",
"accuracy": 42
},
{
"skill": "problem-solving",
"accuracy": 40
}
]
}]
}In this example, the `accuracy` field represents the accuracy of each resume, and `skills_insights` provides insights into the skills mentioned in the resumes.
Make sure to adapt these instructions based on the actual response structure provided by the API.