How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AI Applyd User Documents API

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

AI Applyd User Documents API is one of 46 APIs that AI Applyd publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 4 JSON Schema definitions.

Tagged areas include User Documents. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and 4 JSON Schemas.

This API exposes 19 operations across 16 paths, and defines 44 schemas. It is described by OpenAPI 3.2.0, at version 115c47ce.

Requests are made against a single base URL, https://api.aiapplyd.com/api/v1.

19 operations 16 paths 44 schemas 1 DELETE5 GET12 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
115c47ce
Base URL
https://api.aiapplyd.com/api/v1
Authentication
HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 1

AI Applyd User Documents API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Session token from signing in to AI Applyd, sent as Authorization: Bearer .

Paths & Operations 19

Across 16 paths, the API surfaces 19 operations — 1 DELETE, 5 GET, 12 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

user-documents 19
GET
/user-documents
List User Documents
getUserDocuments 3 params → 200401404500
POST
/user-documents
Create User Document
postUserDocuments body → 201400401403404500
POST
/user-documents/translate-preview
Translate Preview (Temporary)
postUserDocumentsTranslatePreview body → 200400401403404500
POST
/user-documents/save-translation
Save Translation Preview
postUserDocumentsSaveTranslation body → 201400401403404500
POST
/user-documents/ats-score-preview
ATS Score Preview (Temporary)
postUserDocumentsAtsScorePreview body → 200400401403404500
POST
/user-documents/ats-optimize-preview
ATS Optimize Preview (Temporary)
postUserDocumentsAtsOptimizePreview body → 200400401403404500
GET
/user-documents/{id}/parse-status
Get User Document Parse Status
getUserDocumentsByIdParseStatus 1 param → 200401404500
GET
/user-documents/{id}
Get User Document
getUserDocumentsById 1 param → 200401404500
PUT
/user-documents/{id}
Update User Document
putUserDocumentsById 1 param body → 200400401404500
DELETE
/user-documents/{id}
Delete User Document
deleteUserDocumentsById 1 param → 200400401404500
POST
/user-documents/{id}/set-base
Set Base Document
postUserDocumentsByIdSetBase 1 param → 200400401404500
POST
/user-documents/{id}/upload
Upload User Document File
postUserDocumentsByIdUpload 1 param body → 200400401404500
GET
/user-documents/{id}/download
Download User Document File
getUserDocumentsByIdDownload 1 param → 200401404500
POST
/user-documents/{id}/translate
Translate User Document
postUserDocumentsByIdTranslate 1 param body → 201400401404500
POST
/user-documents/{id}/tailor
Tailor User Document for Job
postUserDocumentsByIdTailor 1 param body → 201400401404500
POST
/user-documents/{id}/ats-score
ATS Score User Document
postUserDocumentsByIdAtsScore 1 param body → 200400401403404500
POST
/user-documents/{id}/ats-optimize
ATS Optimize User Document
postUserDocumentsByIdAtsOptimize 1 param body → 200400401403404500
POST
/user-documents/{id}/share
Share/Unshare User Document
postUserDocumentsByIdShare 1 param body → 200400401404409500
GET
/user-documents/shared/{token}
Get Shared Document
getUserDocumentsSharedByToken 2 params → 200401404500

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are ParsedResumeData (29 properties), UserDocument (26 properties), ResumePrefill (16 properties), AtsScoreData (10 properties). Each schema is shown below with its type and property counts.

AtsRequirementMapping
object
4 properties 4 required
SetBaseDocumentResponse
object
Successful API response
3 properties 2 required
ResponseMetadata
object
5 properties
ShareDocumentResponse
object
Successful API response
3 properties 2 required
CreateUserDocumentRequest
object
3 properties 2 required
SharedDocumentResponse
object
Successful API response
3 properties 2 required
AtsScoreResponse
object
Successful API response
3 properties 2 required
TranslateDocumentRequest
object
2 properties
TranslateDocumentTranslationItem
object
3 properties 3 required
UserDocument
object
26 properties 15 required
ParsedResumeData
object
29 properties 23 required
AtsOptimizeDocumentRequest
object
2 properties
UserDocumentCreatedResponse
object
Successful API response
3 properties 2 required
AtsRoleClassification
objectnull
Role classification and archetype detection (populated when jobDescription is provided, null otherwise)
4 properties 4 required
AtsOptimizePreviewRequest
object
1 property
SaveTranslationPreviewRequest
object
2 properties 2 required
AtsScoreData
object
10 properties 10 required
TranslateDocumentResponse
object
Successful API response
3 properties 2 required
ShareDocumentRequest
object
1 property 1 required
ResumeFieldEvidence
object
3 properties 3 required
UpdateUserDocumentRequest
object
3 properties
AtsOptimizeDocumentData
object
3 properties 3 required
SharedDocumentData
object
7 properties 7 required
WorkExperienceItem
object
7 properties 6 required
UserDocumentParseStatusData
object
3 properties 3 required
AtsScorePreviewRequest
object
1 property
AtsKeywordStrategy
objectnull
Keyword injection strategy by resume section (populated when jobDescription is provided, null otherwise)
4 properties 4 required
UserDocumentSuccessResponse
object
Successful API response
3 properties 2 required
TailorDocumentRequest
object
1 property 1 required
AtsOptimizeDocumentResponse
object
Successful API response
3 properties 2 required
AtsGapAnalysis
object
4 properties 4 required
TranslatePreviewTranslationItem
object
2 properties 2 required
AtsSuggestion
object
3 properties 3 required
UserDocumentListResponse
object
Successful API response
3 properties 2 required
TranslatePreviewRequest
object
1 property 1 required
EducationItem
object
3 properties 3 required
ResumePrefill
object
16 properties 15 required
AtsScoreRequest
object
1 property 1 required
UserDocumentParseStatusResponse
object
Successful API response
3 properties 2 required
TranslatePreviewResponse
object
Successful API response
3 properties 2 required
ApiErrorResponse
object
3 properties 2 required
UserDocumentResponse
object
Successful API response
3 properties 2 required
UserDocumentListData
objectnull
2 properties 2 required
ShareDocumentData
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aiapplyd-user-documents-api-openapi.yml Raw ↑

Other APIs AI Applyd publishes across the network.

AI Applyd MCP Server
AI Applyd Account API
AI Applyd Achievements API
AI Applyd AI API
AI Applyd AI Persona API
AI Applyd Analytics API
AI Applyd Application Profile API
AI Applyd Applications API
AI Applyd Ats API
AI Applyd Auth API
AI Applyd Billing API
AI Applyd Blog API
Where this information came from

This is an independent, third-party profile of AI Applyd User Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.