{
  "info": {
    "_postman_id": "8c7e9f02-3a4d-4b6f-9e1a-1c5d8f2b7a3e",
    "name": "Aptly Intelligence API",
    "description": "Postman collection for the Aptly Intelligence API. Covers the public, X-API-Key authenticated endpoints: POST /api/v1/screen and GET /api/v1/jobs/{job_id}. Set the apiKey collection variable to the key you generated in the Aptly app under Profile then API Keys, then run any request. baseUrl defaults to production at https://api.aptly.pro, change it to a local URL when developing against a local backend.",
    "schema": "https://schema.postman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "X-API-Key",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.aptly.pro",
      "type": "string"
    },
    {
      "key": "apiKey",
      "value": "aptly_your_key_here",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Submit screening job (minimal)",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/screen",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "screen"
          ]
        },
        "body": {
          "mode": "raw",
          "raw": "{\n  \"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.\",\n  \"candidates\": [\n    {\n      \"candidate_ref\": \"cand-001\",\n      \"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.\"\n    }\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "description": "Submit a single CV against a job spec. The response includes a job_id, poll it with the Retrieve job results request until status is complete."
      }
    },
    {
      "name": "Submit screening job (with webhook)",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v1/screen",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "screen"
          ]
        },
        "body": {
          "mode": "raw",
          "raw": "{\n  \"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.\",\n  \"candidates\": [\n    {\n      \"candidate_ref\": \"cand-001\",\n      \"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.\"\n    },\n    {\n      \"candidate_ref\": \"cand-002\",\n      \"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.\"\n    }\n  ],\n  \"webhook_url\": \"https://webhook.site/your-unique-url\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "description": "Submit two CVs and provide a webhook_url. When webhook_url is set, 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."
      }
    },
    {
      "name": "Retrieve job results",
      "request": {
        "method": "GET",
        "header": [],
        "url": {
          "raw": "{{baseUrl}}/api/v1/jobs/{{jobId}}",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v1",
            "jobs",
            "{{jobId}}"
          ]
        },
        "description": "Poll a screening job by its job_id. Set the jobId variable in this collection (or in your active environment) to the value returned by one of the Submit screening job requests, or substitute it directly in the URL. Results are retained for 72 hours after a job completes; after that this endpoint returns 410 Gone."
      }
    }
  ]
}