# Aptly Intelligence API, VS Code REST Client requests. # # Install the REST Client extension by Huachao Mao to send these # requests directly from VS Code. A "Send Request" link appears # above each request block below; click it to fire the request. # # Replace the apiKey value below with the key you generated in # the Aptly app under Profile then API Keys. Keys start with # aptly_ and are only shown once at creation time, so store # yours somewhere safe. # # baseUrl defaults to production. Point it at a local backend # (for example http://localhost:8000) when developing. @baseUrl = https://api.aptly.pro @apiKey = aptly_your_key_here ### # Submit a screening job (minimal example, no webhook). # The response includes a job_id, poll it with the third # request below until status is "complete". POST {{baseUrl}}/api/v1/screen Content-Type: application/json X-API-Key: {{apiKey}} { "job_spec": "We are hiring a Senior Python Backend Engineer to lead the design and rollout of our payments service. Must-haves: 5+ years building production Python services, deep experience with FastAPI or Django REST framework, and strong SQL on PostgreSQL. Nice to haves include experience with event-driven systems (Kafka or NATS), containerised deployments on AWS or GCP, and a track record of mentoring mid-level engineers. Remote-friendly within EU or UK timezones.", "candidates": [ { "candidate_ref": "cand-001", "cv_text": "Senior software engineer with 7 years of Python experience, the last 4 building FastAPI services for a fintech platform handling 2M daily transactions. Led the migration from a monolith to event-driven microservices on AWS using SQS and Aurora Postgres. Mentors two junior engineers and runs the team's onboarding programme." } ] } ### # Submit a screening job with a webhook URL. # When webhook_url is provided, Aptly POSTs the completed # results to that URL once scoring finishes, so you do not # have to poll. webhook.site is a free service that gives you # a temporary URL for inspecting webhook payloads during local # development, replace the placeholder with your own URL. POST {{baseUrl}}/api/v1/screen Content-Type: application/json X-API-Key: {{apiKey}} { "job_spec": "We are hiring a Senior Python Backend Engineer to lead the design and rollout of our payments service. Must-haves: 5+ years building production Python services, deep experience with FastAPI or Django REST framework, and strong SQL on PostgreSQL. Nice to haves include experience with event-driven systems (Kafka or NATS), containerised deployments on AWS or GCP, and a track record of mentoring mid-level engineers. Remote-friendly within EU or UK timezones.", "candidates": [ { "candidate_ref": "cand-001", "cv_text": "Senior software engineer with 7 years of Python experience, the last 4 building FastAPI services for a fintech platform handling 2M daily transactions. Led the migration from a monolith to event-driven microservices on AWS using SQS and Aurora Postgres. Mentors two junior engineers and runs the team's onboarding programme." }, { "candidate_ref": "cand-002", "cv_text": "Backend developer with 3 years of professional Python and Django experience at a logistics SaaS company. Comfortable with REST API design, Postgres schema work, and Docker on Heroku. Currently studying Kafka in spare time, no production exposure to event-driven systems yet." } ], "webhook_url": "https://webhook.site/your-unique-url" } ### # Retrieve job results. # Substitute the path segment below with the job_id returned # by one of the POST requests above. Results are retained for # 72 hours after a job completes; after that this endpoint # returns 410 Gone. GET {{baseUrl}}/api/v1/jobs/REPLACE_WITH_JOB_ID_FROM_PREVIOUS_REQUEST X-API-Key: {{apiKey}}