AI Applyd

AI Applyd User Documents API

The user-documents API from AI Applyd — 16 operation(s) for user-documents.

GitHub OpenAPI

Operations 19

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

GET /user-documents List my saved documents · List User Documents #
Ask an LLM
“Which resumes and cover letters have I uploaded?”
“Can I filter my saved documents to just one type, like cover letters?”
Tell an agent
List all my saved documents.
Show my documents of type {type}.
POST /user-documents Create a document record · Create User Document #
Ask an LLM
“How do I create a new document entry before uploading its file?”
“Can I create a temporary document that isn't kept long-term?”
Tell an agent
Create a {documentType} document titled {title}.
Add a temporary {documentType} document record named {title}.
POST /user-documents/translate-preview Preview a file translation without saving · Translate Preview (Temporary) #
Ask an LLM
“Can I see what my resume looks like translated before I save anything?”
“Is there a try-it translation for an uploaded file into several languages at once?”
Tell an agent
Translate {file} into {targetLanguages} as a preview, without saving it.
Show me a temporary translation of this upload into {targetLanguages}.
POST /user-documents/save-translation Save a translation preview as a document · Save Translation Preview #
Ask an LLM
“How do I keep a translation preview I liked as a real document?”
“Does saving a translated preview also generate a PDF?”
Tell an agent
Save this translated text {contentMarkdown} as a new document titled {title}.
Keep the translation preview as document {title} with a generated PDF: {contentMarkdown}.
POST /user-documents/ats-score-preview ATS-score an uploaded file without saving · ATS Score Preview (Temporary) #
Ask an LLM
“Can I get an ATS score for a resume file without adding it to my documents?”
“What would an unsaved resume upload score against a job posting?”
Tell an agent
Score the file {file} for ATS compatibility without saving it.
Give a throwaway ATS score for {file} against this job description: {jobDescription}.
POST /user-documents/ats-optimize-preview Preview ATS-optimized content for an upload · ATS Optimize Preview (Temporary) #
Ask an LLM
“Can I see an ATS-optimized version of a resume file before committing to it?”
“Is it possible to optimize an uploaded resume for a job without storing the result?”
Tell an agent
Show an ATS-optimized preview of {file} without saving.
Preview how {file} would be rewritten for this job description: {jobDescription}.
GET /user-documents/{id}/parse-status Check whether a resume has finished parsing · Get User Document Parse Status #
Ask an LLM
“Has the AI finished reading the resume I just uploaded?”
“When is a document's parsed data ready to use?”
Tell an agent
Check the parse status of document {id}.
Poll whether document {id} is parsed and return its data if ready.
GET /user-documents/{id} Get one saved document · Get User Document #
Ask an LLM
“Can I look up the details of a single saved document?”
“What title and type does a particular document of mine have?”
Tell an agent
Show me document {id}.
Get the metadata for my document {id}.
PUT /user-documents/{id} Rename or retype a saved document · Update User Document #
Ask an LLM
“How do I rename one of my uploaded documents?”
“Can I change a document's type or edit its markdown content?”
Tell an agent
Rename document {id} to {title}.
Change the type of document {id} to {documentType}.
DELETE /user-documents/{id} Delete a saved document and its file · Delete User Document #
Ask an LLM
“How can I delete an uploaded resume along with its stored file?”
“Does removing a document also delete the file behind it?”
Tell an agent destructive · confirm first
Delete document {id} and its file.
Permanently remove my saved document {id}.
POST /user-documents/{id}/set-base Mark a document as my base for its type · Set Base Document #
Ask an LLM
“How do I set which uploaded resume is my base resume?”
“Can I have more than one base document per type?”
Tell an agent
Set document {id} as my base document for its type.
Make {id} my base resume.
POST /user-documents/{id}/upload Upload a file to a document record · Upload User Document File #
Ask an LLM
“What file types and size can I upload to a document?”
“How do I attach a PDF or DOCX to a document record I created?”
Tell an agent
Upload {file} to document {id}.
Attach this PDF {file} to my document record {id}.
GET /user-documents/{id}/download Download a saved document's file · Download User Document File #
Ask an LLM
“Can I download the original file of a document I uploaded?”
“Where do I get the PDF behind one of my saved documents?”
Tell an agent
Download the file for document {id}.
Fetch the stored file of my document {id}.
POST /user-documents/{id}/translate Translate a saved document into other languages · Translate User Document #
Ask an LLM
“Can AI translate a document I've already saved and keep the copies?”
“Does translating a saved document make a new copy for each language?”
Tell an agent
Translate saved document {id} into {targetLanguage}.
Create translated copies of document {id} in {targetLanguages}.
POST /user-documents/{id}/tailor Tailor a resume document to a job listing · Tailor User Document for Job #
Ask an LLM
“Can AI tailor one of my uploaded resumes to a specific job listing?”
“Does tailoring a resume overwrite the original or create a new copy?”
Tell an agent
Tailor document {id} for job listing {jobListingId}.
Make a tailored copy of resume {id} aimed at job listing {jobListingId}.
POST /user-documents/{id}/ats-score ATS-score a saved resume document · ATS Score User Document #
Ask an LLM
“What ATS score does a resume I've already uploaded get?”
“Can I score a saved resume document against a particular job description?”
Tell an agent
Score saved document {id} for ATS against this job description: {jobDescription}.
Check the ATS compatibility of my uploaded resume {id} for {jobDescription}.
POST /user-documents/{id}/ats-optimize ATS-optimize a saved resume document · ATS Optimize User Document #
Ask an LLM
“Can AI improve the ATS compatibility of a resume I uploaded and re-score it?”
“Is there an option to apply ATS changes directly to a saved document?”
Tell an agent
Optimize saved document {id} for ATS.
Optimize document {id} for this job description {jobDescription} and apply the changes: {apply}.
POST /user-documents/{id}/share Share or unshare a saved document · Share/Unshare User Document #
Ask an LLM
“How do I make one of my uploaded documents viewable by link?”
“Can I stop publicly sharing a document I uploaded?”
Tell an agent
Turn on public sharing for document {id}.
Set public sharing on uploaded document {id} to {isPublic}.
GET /user-documents/shared/{token} View a publicly shared document · Get Shared Document #
Ask an LLM
“Can I open a shared document link without logging in?”
“Is it possible to include the content when viewing a shared document?”
Tell an agent
Open the shared document with token {token}.
View shared document {token} including its content: {content}.

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aiapplyd/refs/heads/main/openapi/aiapplyd-user-documents-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-user-documents-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-user-documents-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 User Documents API
  version: 115c47ce
servers:
- description: Current environment
  url: https://api.aiapplyd.com/api/v1
security:
- BearerAuth: []
tags:


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