AI Applyd

AI Applyd Onboarding API

The onboarding API from AI Applyd — 8 operation(s) for onboarding.

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /onboarding/parse-resume Parse a resume to start my profile · Parse Resume for Onboarding #
Ask an LLM
“Can I upload my resume during sign-up and have my profile filled from it?”
“Which file formats does onboarding accept for resume parsing?”
Tell an agent
Parse my resume {file} for onboarding.
Extract my profile details from already-uploaded document {documentId} during setup.
POST /onboarding/auto-setup Set up my account and matches from my resume · Auto-Setup from Parsed Resume #
Ask an LLM
“Can onboarding create my job preferences and kick off job searches in one step?”
“What details do I need to supply to finish automatic setup from my parsed resume?”
Tell an agent
Auto-setup my account as {fullName} in {city}, {state}, {country} with email {email} and phone {phone}.
Finish setup targeting {suggestedJobTitles} in {suggestedLocations} with skills {skills} and work styles {workStyles}.
GET /onboarding/discover-status Check first-time match discovery progress · Poll Background Match Discovery Status #
Ask an LLM
“Is the initial job search after setup still running or did it fail?”
“When will my first matches be ready after onboarding?”
Tell an agent
Check the status of my background match discovery.
Tell me whether the job discovery started by setup has finished.
POST /onboarding/profile Save answers from the onboarding wizard · Upsert Onboarding Profile #
Ask an LLM
“Can I save my wizard answers one screen at a time?”
“Where do I record my job timeline and target interviews per week during setup?”
Tell an agent
Save my onboarding roles as {roles}.
Record my goal {goal} and a target of {interviewsPerWeekTarget} interviews per week.
GET /onboarding/profile Get my onboarding wizard answers · Get Onboarding Profile #
Ask an LLM
“What answers did I give in the onboarding wizard?”
“Have I started the setup questionnaire yet?”
Tell an agent
Show my onboarding wizard answers.
Load what I entered so far in the setup questionnaire.
GET /onboarding/resume-prefill See which fields came from my resume · Get Resume Prefill #
Ask an LLM
“Which of my profile fields are still using what was read from my resume?”
“What cities from my resume can I pick as location options?”
Tell an agent
Show which profile and preference fields were prefilled from my base resume.
List the resume cities I can offer as location chips.
POST /onboarding/complete Finish onboarding · Complete Onboarding #
Ask an LLM
“What happens when I complete the setup wizard?”
“Can I pick an auto-apply mode as I finish onboarding?”
Tell an agent
Complete my onboarding.
Finish onboarding with auto-apply mode {autoApplyMode}.
POST /onboarding/escrow Hold anonymous setup answers before sign-in · Mint Onboarding Escrow #
Ask an LLM
“Will my answers survive if I open the magic sign-in link in a different browser?”
“Can pre-signup answers be stored server-side and referenced later?”
Tell an agent
Store my answers {answers} from screen {screen} before I sign in.
Mint an escrow reference for the answers {answers} at screen {screen}.
POST /onboarding/escrow/redeem Recover setup answers after sign-in · Redeem Onboarding Escrow #
Ask an LLM
“Can I get back the answers I gave before signing in?”
“What's returned when an escrow reference has expired or was already used?”
Tell an agent
Redeem escrow reference {ref} to recover my answers.
Exchange {ref} for the saved pre-signup answers.

Documentation

📖
APIReference
https://api.aiapplyd.com/api/v1/scalar

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aiapplyd/refs/heads/main/openapi/aiapplyd-onboarding-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiapplyd/refs/heads/main/json-schema/aiapplyd-patch-user-preferences-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiapplyd/refs/heads/main/json-schema/aiapplyd-upsert-application-profile-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiapplyd/refs/heads/main/json-schema/aiapplyd-auto-setup-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/aiapplyd/refs/heads/main/json-schema/aiapplyd-update-preferences-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aiapplyd:aiapplyd-onboarding-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aiapplyd-onboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@aiapplyd.com
    name: AI Applyd
    url: https://aiapplyd.com
  description: 'The AI Applyd API runs the whole job hunt for you: it matches you to roles that fit your profile, rewrites your resume for each posting, writes the cover letter the form asks for, and auto-applies across the major applicant tracking systems.'
  license:
    name: Proprietary
    url: https://aiapplyd.com/legal/terms
  title: AI Applyd Onboarding API
  version: 115c47ce
servers:
- description: Current environment
  url: https://api.aiapplyd.com/api/v1
security:
- BearerAuth: []
tags:


# --- truncated at 32 KB (69 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aiapplyd/refs/heads/main/openapi/aiapplyd-onboarding-api-openapi.yml