A one-of-a-kind resume builder that keeps your privacy in mind. Completely secure, customizable, portable, open-source and free forever. Try it out today!
TypeScript agent-skillsaidsh-pluginhacktoberfestjavascriptmcp-serverreactresume-builderself-hostedtypescript
{
"info": {
"title": "Reactive Resume",
"version": "6.0.10",
"description": "Reactive Resume API. Mutations do not support Idempotency-Key. Do not automatically retry POST, PUT, PATCH or DELETE requests after a timeout: first read the resource to determine whether the operation succeeded. Existing enum values and response shapes are retained for compatibility.",
"license": {
"name": "MIT",
"url": "https://github.com/reactive-resume/reactive-resume/blob/main/LICENSE"
},
"contact": {
"name": "Amruth Pillai",
"email": "[email protected]",
"url": "https://amruthpillai.com"
}
},
"servers": [
{
"url": "https://rxresu.me/api/openapi"
}
],
"paths": {
"/api/health": {
"get": {
"operationId": "getHealth",
"tags": [
"System"
],
"summary": "Get application health and version",
"description": "Checks database and storage availability. Does not require authentication.",
"servers": [
{
"url": "https://rxresu.me"
}
],
"security": [],
"responses": {
"200": {
"description": "The application and its dependencies are healthy.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"service": {
"type": "string",
"enum": [
"reactive-resume"
]
},
"version": {
"type": "string",
"description": "The running application's build version."
},
"revision": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-f0-9]{40}$"
},
{
"enum": [
null
]
}
],
"description": "The full Git commit embedded in the running Docker image, or null when unknown."
},
"status": {
"type": "string",
"enum": [
"healthy",
"unhealthy"
]
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"uptime": {
"type": "string"
},
"database": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"unhealthy"
]
},
"latencyMs": {
"type": "number"
},
"error": {
"type": "string",
"description": "Generic failure message. Detailed diagnostics are logged on the server."
}
},
"required": [
"status",
"latencyMs"
],
"additionalProperties": true
},
"storage": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"unhealthy"
]
},
"latencyMs": {
"type": "number"
},
"error": {
"type": "string",
"description": "Generic failure message. Detailed diagnostics are logged on the server."
}
},
"required": [
"status",
"latencyMs"
],
"additionalProperties": true
},
"redis": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"unhealthy"
]
},
"latencyMs": {
"type": "number"
},
"error": {
"type": "string",
"description": "Generic failure message. Detailed diagnostics are logged on the server."
}
},
"required": [
"status",
"latencyMs"
],
"additionalProperties": true,
"description": "Present only when REDIS_URL is configured. An unhealthy Redis makes the overall status unhealthy."
}
},
"required": [
"service",
"version",
"revision",
"status",
"timestamp",
"uptime",
"database",
"storage"
]
}
}
}
},
"503": {
"description": "One or more application dependencies are unhealthy.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"service": {
"type": "string",
"enum": [
"reactive-resume"
]
},
"version": {
"type": "string",
"description": "The running application's build version."
},
"revision": {
"anyOf": [
{
"type": "string",
"pattern": "^[a-f0-9]{40}$"
},
{
"enum": [
null
]
}
],
"description": "The full Git commit embedded in the running Docker image, or null when unknown."
},
"status": {
"type": "string",
"enum": [
"healthy",
"unhealthy"
]
},
"timestamp": {
"type": "string",
"format": "date-time"
},
"uptime": {
"type": "string"
},
"database": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"unhealthy"
]
},
"latencyMs": {
"type": "number"
},
"error": {
"type": "string",
"description": "Generic failure message. Detailed diagnostics are logged on the server."
}
},
"required": [
"status",
"latencyMs"
],
"additionalProperties": true
},
"storage": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"unhealthy"
]
},
"latencyMs": {
"type": "number"
},
"error": {
"type": "string",
"description": "Generic failure message. Detailed diagnostics are logged on the server."
}
},
"required": [
"status",
"latencyMs"
],
"additionalProperties": true
},
"redis": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"healthy",
"unhealthy"
]
},
"latencyMs": {
"type": "number"
},
"error": {
"type": "string",
"description": "Generic failure message. Detailed diagnostics are logged on the server."
}
},
"required": [
"status",
"latencyMs"
],
"additionalProperties": true,
"description": "Present only when REDIS_URL is configured. An unhealthy Redis makes the overall status unhealthy."
}
},
"required": [
"service",
"version",
"revision",
"status",
"timestamp",
"uptime",
"database",
"storage"
]
}
}
}
}
},
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/health\""
}
]
}
},
"/application-profile": {
"get": {
"operationId": "getApplicationProfile",
"summary": "Read your private application profile",
"tags": [
"Application Profile"
],
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"givenName": {
"type": "string",
"maxLength": 200,
"default": ""
},
"familyName": {
"type": "string",
"maxLength": 200,
"default": ""
},
"email": {
"anyOf": [
{
"const": ""
},
{
"type": "string",
"maxLength": 320,
"format": "email"
}
],
"default": ""
},
"phone": {
"type": "string",
"maxLength": 200,
"default": ""
},
"links": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"url": {
"type": "string",
"maxLength": 2000,
"format": "uri"
}
},
"required": [
"label",
"url"
],
"additionalProperties": false
},
"default": []
},
"address": {
"type": "object",
"properties": {
"line1": {
"type": "string",
"maxLength": 200,
"default": ""
},
"line2": {
"type": "string",
"maxLength": 200,
"default": ""
},
"city": {
"type": "string",
"maxLength": 200,
"default": ""
},
"region": {
"type": "string",
"maxLength": 200,
"default": ""
},
"postalCode": {
"type": "string",
"maxLength": 200,
"default": ""
},
"countryCode": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{2}$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false,
"default": {
"line1": "",
"line2": "",
"city": "",
"region": "",
"postalCode": "",
"countryCode": null
}
},
"workAuthorization": {
"type": "array",
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"countryCode": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"authorized": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"default": "unknown"
},
"needsSponsorship": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"default": "unknown"
}
},
"required": [
"countryCode"
],
"additionalProperties": false
},
"default": []
},
"willingToRelocate": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"default": "unknown"
},
"requestedSalary": {
"anyOf": [
{
"type": "object",
"properties": {
"amount": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 9007199254740991,
"multipleOf": 0.01
},
{
"type": "null"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{3}$"
},
{
"type": "null"
}
]
},
"period": {
"anyOf": [
{
"enum": [
"hour",
"month",
"year"
],
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"amount",
"currency",
"period"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"references": {
"type": "array",
"maxItems": 10,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"relationship": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"maxLength": 200
},
"email": {
"anyOf": [
{
"const": ""
},
{
"type": "string",
"maxLength": 320,
"format": "email"
}
]
},
"phone": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"relationship",
"company",
"email",
"phone"
],
"additionalProperties": false
},
"default": []
}
},
"additionalProperties": false
},
"reviewedAt": {
"type": "string",
"format": "date-time"
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"data",
"reviewedAt",
"revision"
]
},
{
"type": "null"
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/application-profile\" --header \"x-api-key: <api-key>\""
}
]
},
"put": {
"operationId": "saveApplicationProfile",
"summary": "Save your application profile",
"tags": [
"Application Profile"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"givenName": {
"type": "string",
"maxLength": 200,
"default": ""
},
"familyName": {
"type": "string",
"maxLength": 200,
"default": ""
},
"email": {
"anyOf": [
{
"const": ""
},
{
"type": "string",
"maxLength": 320,
"format": "email"
}
],
"default": ""
},
"phone": {
"type": "string",
"maxLength": 200,
"default": ""
},
"links": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"url": {
"type": "string",
"maxLength": 2000,
"format": "uri"
}
},
"required": [
"label",
"url"
],
"additionalProperties": false
},
"default": []
},
"address": {
"type": "object",
"properties": {
"line1": {
"type": "string",
"maxLength": 200,
"default": ""
},
"line2": {
"type": "string",
"maxLength": 200,
"default": ""
},
"city": {
"type": "string",
"maxLength": 200,
"default": ""
},
"region": {
"type": "string",
"maxLength": 200,
"default": ""
},
"postalCode": {
"type": "string",
"maxLength": 200,
"default": ""
},
"countryCode": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{2}$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false,
"default": {
"line1": "",
"line2": "",
"city": "",
"region": "",
"postalCode": "",
"countryCode": null
}
},
"workAuthorization": {
"type": "array",
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"countryCode": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"authorized": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"default": "unknown"
},
"needsSponsorship": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"default": "unknown"
}
},
"required": [
"countryCode"
],
"additionalProperties": false
},
"default": []
},
"willingToRelocate": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"default": "unknown"
},
"requestedSalary": {
"anyOf": [
{
"type": "object",
"properties": {
"amount": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 9007199254740991,
"multipleOf": 0.01
},
{
"type": "null"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{3}$"
},
{
"type": "null"
}
]
},
"period": {
"anyOf": [
{
"enum": [
"hour",
"month",
"year"
],
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"amount",
"currency",
"period"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"references": {
"type": "array",
"maxItems": 10,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"relationship": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"maxLength": 200
},
"email": {
"anyOf": [
{
"const": ""
},
{
"type": "string",
"maxLength": 320,
"format": "email"
}
]
},
"phone": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"relationship",
"company",
"email",
"phone"
],
"additionalProperties": false
},
"default": []
}
},
"additionalProperties": false
},
"expectedRevision": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 64
},
{
"type": "null"
}
]
}
},
"required": [
"data",
"expectedRevision"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"givenName": {
"type": "string",
"maxLength": 200,
"default": ""
},
"familyName": {
"type": "string",
"maxLength": 200,
"default": ""
},
"email": {
"anyOf": [
{
"const": ""
},
{
"type": "string",
"maxLength": 320,
"format": "email"
}
],
"default": ""
},
"phone": {
"type": "string",
"maxLength": 200,
"default": ""
},
"links": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"url": {
"type": "string",
"maxLength": 2000,
"format": "uri"
}
},
"required": [
"label",
"url"
],
"additionalProperties": false
},
"default": []
},
"address": {
"type": "object",
"properties": {
"line1": {
"type": "string",
"maxLength": 200,
"default": ""
},
"line2": {
"type": "string",
"maxLength": 200,
"default": ""
},
"city": {
"type": "string",
"maxLength": 200,
"default": ""
},
"region": {
"type": "string",
"maxLength": 200,
"default": ""
},
"postalCode": {
"type": "string",
"maxLength": 200,
"default": ""
},
"countryCode": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{2}$"
},
{
"type": "null"
}
],
"default": null
}
},
"additionalProperties": false,
"default": {
"line1": "",
"line2": "",
"city": "",
"region": "",
"postalCode": "",
"countryCode": null
}
},
"workAuthorization": {
"type": "array",
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"countryCode": {
"type": "string",
"pattern": "^[A-Z]{2}$"
},
"authorized": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"default": "unknown"
},
"needsSponsorship": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"default": "unknown"
}
},
"required": [
"countryCode"
],
"additionalProperties": false
},
"default": []
},
"willingToRelocate": {
"enum": [
"unknown",
"yes",
"no"
],
"type": "string",
"default": "unknown"
},
"requestedSalary": {
"anyOf": [
{
"type": "object",
"properties": {
"amount": {
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 9007199254740991,
"multipleOf": 0.01
},
{
"type": "null"
}
]
},
"currency": {
"anyOf": [
{
"type": "string",
"pattern": "^[A-Z]{3}$"
},
{
"type": "null"
}
]
},
"period": {
"anyOf": [
{
"enum": [
"hour",
"month",
"year"
],
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"amount",
"currency",
"period"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
},
"references": {
"type": "array",
"maxItems": 10,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"relationship": {
"type": "string",
"maxLength": 200
},
"company": {
"type": "string",
"maxLength": 200
},
"email": {
"anyOf": [
{
"const": ""
},
{
"type": "string",
"maxLength": 320,
"format": "email"
}
]
},
"phone": {
"type": "string",
"maxLength": 200
}
},
"required": [
"name",
"relationship",
"company",
"email",
"phone"
],
"additionalProperties": false
},
"default": []
}
},
"additionalProperties": false
},
"reviewedAt": {
"type": "string",
"format": "date-time"
},
"revision": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"data",
"reviewedAt",
"revision"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PUT \"https://rxresu.me/api/openapi/application-profile\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"data\": {},\n \"expectedRevision\": \"<string>\"\n}'"
}
]
},
"delete": {
"operationId": "deleteApplicationProfile",
"summary": "Delete your private application profile",
"tags": [
"Application Profile"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"required": [
"expectedRevision"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/application-profile\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"expectedRevision\": \"<string>\"\n}'"
}
]
}
},
"/ai/usage": {
"get": {
"operationId": "getWeeklyAiUsage",
"summary": "Get this week's AI provider request attempts",
"tags": [
"AI"
],
"parameters": [
{
"name": "includeWebSearch",
"in": "query",
"schema": {
"type": "boolean"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"start": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"end": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"timezone": {
"type": "string"
},
"requests": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"enum": [
"provider-test",
"import-pdf",
"import-docx",
"writing-review",
"improve",
"parse-posting",
"web-search",
"autofill-posting",
"match-score",
"tailor-resume",
"draft-message",
"draft-letter",
"role-suggestions",
"fit",
"briefing",
"practice",
"debrief",
"reply",
"answer",
"assistant",
"career-chat",
"transcription",
"speech"
],
"type": "string"
},
"providerId": {
"type": "string"
},
"label": {
"type": "string"
},
"provider": {
"type": "string"
},
"model": {
"type": "string"
},
"requests": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"action",
"providerId",
"label",
"provider",
"model",
"requests"
]
}
}
},
"required": [
"start",
"end",
"timezone",
"requests",
"groups"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/ai/usage\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/ai/content-reports": {
"post": {
"operationId": "reportAiContent",
"summary": "Report unsafe AI-generated or publicly shared resume content to the server operator",
"description": "Privately stores only the content and explanation the user submits. Does not send a report to an AI provider. Reports are deleted with the reporting account.",
"tags": [
"AI"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"source": {
"enum": [
"assistant",
"writing",
"letter",
"career",
"import",
"public-resume",
"other"
],
"type": "string"
},
"reason": {
"enum": [
"hate",
"sexual",
"violence",
"dangerous",
"other"
],
"type": "string"
},
"content": {
"type": "string",
"minLength": 1,
"maxLength": 20000
},
"note": {
"type": "string",
"maxLength": 1000,
"default": ""
}
},
"required": [
"source",
"reason",
"content"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/ai/content-reports\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"source\": \"assistant\",\n \"reason\": \"hate\",\n \"content\": \"<string>\"\n}'"
}
]
}
},
"/ai/capabilities": {
"get": {
"operationId": "getAiCapabilities",
"summary": "Get supported AI consent and web-search capabilities",
"tags": [
"AI"
],
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"recipientApproval": {
"const": 1
},
"explicitNoAi": {
"const": true
},
"nativeWebSearch": {
"const": 1
}
},
"required": [
"recipientApproval",
"explicitNoAi",
"nativeWebSearch"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/ai/capabilities\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/ai/writing-review/{resumeId}": {
"get": {
"operationId": "getWritingReview",
"summary": "Get the saved writing review for a resume",
"tags": [
"AI"
],
"parameters": [
{
"name": "resumeId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"properties": {
"inputText": {
"type": "string"
},
"passages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"where": {
"type": "string"
},
"text": {
"type": "string"
}
},
"required": [
"id",
"where",
"text"
]
}
},
"review": {
"type": "object",
"properties": {
"summary": {
"type": "string"
},
"suggestions": {},
"strengths": {},
"jdAlignment": {
"anyOf": [
{
"type": "object",
"properties": {
"verdict": {
"type": "string"
},
"missingConcepts": {},
"strengths": {}
},
"required": [
"verdict"
]
},
{
"type": "null"
}
]
}
},
"required": [
"summary",
"jdAlignment"
]
},
"reviewedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"aiOperationIds": {
"type": "array",
"maxItems": 1000,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"aiUsage": {
"anyOf": [
{
"type": "object",
"properties": {
"requests": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"models": {
"type": "array",
"items": {
"type": "object",
"properties": {
"providerId": {
"type": "string"
},
"label": {
"type": "string"
},
"provider": {
"type": "string"
},
"model": {
"type": "string"
}
},
"required": [
"providerId",
"label",
"provider",
"model"
]
}
}
},
"required": [
"requests",
"models"
]
},
{
"type": "null"
}
]
}
},
"required": [
"inputText",
"passages",
"review",
"reviewedAt"
]
},
{
"type": "null"
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/ai/writing-review/<resumeId>\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/ai/parse-pdf": {
"post": {
"operationId": "parseResumePdf",
"summary": "Parse a PDF file into resume data",
"description": "Extracts structured resume data from a PDF file with one of the user's saved AI providers: the one named by `aiProviderId`, or their default. Send the file as a base64-encoded string. Returns a complete ResumeData object and saves nothing.",
"deprecated": true,
"tags": [
"AI"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aiProviderId": {
"type": "string"
},
"file": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string",
"maxLength": 13981018,
"contentEncoding": "base64"
}
},
"required": [
"name",
"data"
]
},
"includeProvenance": {
"type": "boolean"
}
},
"required": [
"file"
]
}
}
}
},
"responses": {
"200": {
"description": "The PDF was successfully parsed into structured resume data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"picture": {
"type": "object",
"properties": {
"hidden": {
"type": "boolean",
"description": "Whether to hide the picture from the resume."
},
"fit": {
"enum": [
"cover",
"contain"
],
"type": "string",
"description": "How the picture fits its frame: cover crops overflow, while contain preserves the whole image."
},
"url": {
"type": "string",
"description": "The URL to the picture to display on the resume. Prefer local app-served paths (for example /uploads/...) populated via upload."
},
"size": {
"type": "number",
"minimum": 32,
"maximum": 512,
"description": "The size of the picture to display on the resume, defined in points (pt)."
},
"rotation": {
"type": "number",
"minimum": 0,
"maximum": 360,
"description": "The rotation of the picture to display on the resume, defined in degrees (°)."
},
"aspectRatio": {
"type": "number",
"minimum": 0.5,
"maximum": 2.5,
"description": "The aspect ratio of the picture to display on the resume, defined as width / height (e.g. 1.5 for 1.5:1 or 0.5 for 1:2)."
},
"borderRadius": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "The border radius of the picture to display on the resume, defined in points (pt)."
},
"borderColor": {
"type": "string",
"description": "The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a)."
},
"borderWidth": {
"type": "number",
"minimum": 0,
"description": "The width of the border of the picture to display on the resume, defined in points (pt)."
},
"shadowColor": {
"type": "string",
"description": "The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a)."
},
"shadowWidth": {
"type": "number",
"minimum": 0,
"description": "The width of the shadow of the picture to display on the resume, defined in points (pt)."
}
},
"required": [
"hidden",
"fit",
"url",
"size",
"rotation",
"aspectRatio",
"borderRadius",
"borderColor",
"borderWidth",
"shadowColor",
"shadowWidth"
],
"description": "Configuration for photograph displayed on the resume"
},
"basics": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full name of the author of the resume."
},
"headline": {
"type": "string",
"description": "The headline of the author of the resume."
},
"email": {
"type": "string",
"description": "The email address of the author of the resume."
},
"phone": {
"type": "string",
"description": "The phone number of the author of the resume."
},
"location": {
"type": "string",
"description": "The location of the author of the resume."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
}
},
"required": [
"url",
"label"
],
"description": "The website of the author of the resume."
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the custom field. Usually generated as a UUID."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"text": {
"type": "string",
"description": "The text to display for the custom field."
},
"link": {
"type": "string",
"description": "If the custom field should be a link, the URL to link to."
}
},
"required": [
"id",
"icon",
"text",
"link"
]
},
"description": "The custom fields to display on the resume."
}
},
"required": [
"name",
"headline",
"email",
"phone",
"location",
"website",
"customFields"
],
"description": "Basic information about the author, such as name, email, phone, location, and website"
},
"summary": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the summary of the resume."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the summary section title in the PDF output. Empty string uses the default summary icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the summary should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the summary from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the summary heading, icon, and decoration while retaining summary content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the summary is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the summary always begins on a new page."
},
"content": {
"type": "string",
"description": "The content of the summary of the resume. This should be a HTML-formatted string."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"content"
],
"description": "Summary section of the resume, useful for a short bio or introduction"
},
"sections": {
"type": "object",
"properties": {
"profiles": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"network": {
"type": "string",
"description": "The name of the network or platform. Empty while the entry is a draft, which isn't printed."
},
"username": {
"type": "string",
"description": "The username of the author on the network or platform."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the profile of the author on the network or platform, if any."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"network",
"username",
"website"
]
},
"description": "The items to display in the profiles section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the profiles of the author."
},
"experience": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"company": {
"type": "string",
"description": "The name of the company or organization. Empty while the entry is a draft, which isn't printed."
},
"position": {
"type": "string",
"description": "The position held at the company or organization. Used when there is only a single role. If multiple roles are provided in the 'roles' field, this serves as a summary title or can be left blank."
},
"location": {
"type": "string",
"description": "The location of the company or organization."
},
"period": {
"type": "string",
"description": "The overall period of time at the company, as text. When multiple roles are used, this should reflect the total tenure. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the company or organization, if any."
},
"description": {
"type": "string",
"description": "The description of the experience. This should be a HTML-formatted string."
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the role. Usually generated as a UUID."
},
"position": {
"type": "string",
"description": "The position or job title for this role."
},
"period": {
"type": "string",
"description": "The period of time this role was held, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"description": {
"type": "string",
"description": "The description of this specific role. This should be a HTML-formatted string."
}
},
"required": [
"id",
"position",
"period",
"description"
]
},
"description": "List of individual roles held at this company to show career progression."
}
},
"required": [
"id",
"hidden",
"company",
"position",
"location",
"period",
"website",
"description",
"roles"
]
},
"description": "The items to display in the experience section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the experience of the author."
},
"education": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"school": {
"type": "string",
"description": "The name of the school or institution. Empty while the entry is a draft, which isn't printed."
},
"degree": {
"type": "string",
"description": "The degree or qualification obtained."
},
"area": {
"type": "string",
"description": "The area of study or specialization."
},
"grade": {
"type": "string",
"description": "The grade or score achieved."
},
"location": {
"type": "string",
"description": "The location of the school or institution."
},
"period": {
"type": "string",
"description": "The period of time the education was obtained over, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the school or institution, if any."
},
"description": {
"type": "string",
"description": "The description of the education. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"school",
"degree",
"area",
"grade",
"location",
"period",
"website",
"description"
]
},
"description": "The items to display in the education section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the education of the author."
},
"projects": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"name": {
"type": "string",
"description": "The name of the project. Empty while the entry is a draft, which isn't printed."
},
"period": {
"type": "string",
"description": "The period of time the project was worked on, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the project, if any."
},
"description": {
"type": "string",
"description": "The description of the project. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"name",
"period",
"website",
"description"
]
},
"description": "The items to display in the projects section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the projects of the author."
},
"skills": {
"description": "The section to display the skills of the author."
},
"languages": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"language": {
"type": "string",
"description": "The name of the language the author knows. Empty while the entry is a draft, which isn't printed."
},
"fluency": {
"type": "string",
"description": "The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2)."
},
"level": {
"type": "number",
"minimum": 0,
"maximum": 5,
"description": "The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."
}
},
"required": [
"id",
"hidden",
"language",
"fluency",
"level"
]
},
"description": "The items to display in the languages section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the languages of the author."
},
"interests": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"name": {
"type": "string",
"description": "The name of the interest/hobby. Empty while the entry is a draft, which isn't printed."
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "The keywords associated with the interest/hobby, if any. These are displayed as tags below the name."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"name",
"keywords"
]
},
"description": "The items to display in the interests section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the interests of the author."
},
"awards": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the award. Empty while the entry is a draft, which isn't printed."
},
"awarder": {
"type": "string",
"description": "The awarder of the award."
},
"date": {
"type": "string",
"description": "The date when the award was received, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the award, if any."
},
"description": {
"type": "string",
"description": "The description of the award. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"awarder",
"date",
"website",
"description"
]
},
"description": "The items to display in the awards section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the awards of the author."
},
"certifications": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the certification. Empty while the entry is a draft, which isn't printed."
},
"issuer": {
"type": "string",
"description": "The issuer of the certification."
},
"date": {
"type": "string",
"description": "The date when the certification was received, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the certification, if any."
},
"description": {
"type": "string",
"description": "The description of the certification. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"issuer",
"date",
"website",
"description"
]
},
"description": "The items to display in the certifications section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the certifications of the author."
},
"publications": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the publication. Empty while the entry is a draft, which isn't printed."
},
"publisher": {
"type": "string",
"description": "The publisher of the publication."
},
"date": {
"type": "string",
"description": "The date when the publication was published, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the publication, if any."
},
"description": {
"type": "string",
"description": "The description of the publication. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"publisher",
"date",
"website",
"description"
]
},
"description": "The items to display in the publications section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the publications of the author."
},
"volunteer": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"organization": {
"type": "string",
"description": "The name of the organization or company. Empty while the entry is a draft, which isn't printed."
},
"location": {
"type": "string",
"description": "The location of the organization or company."
},
"period": {
"type": "string",
"description": "The period of time the author was volunteered at the organization or company, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the organization or company, if any."
},
"description": {
"type": "string",
"description": "The description of the volunteer experience. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"organization",
"location",
"period",
"website",
"description"
]
},
"description": "The items to display in the volunteer section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the volunteer experience of the author."
},
"references": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"name": {
"type": "string",
"description": "The name of the reference, or a note such as 'Available upon request'. Empty while the entry is a draft, which isn't printed."
},
"position": {
"type": "string",
"description": "The position or job title of the reference."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website or LinkedIn profile of the reference, if any."
},
"phone": {
"type": "string",
"description": "The phone number of the reference."
},
"description": {
"type": "string",
"description": "The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"name",
"position",
"website",
"phone",
"description"
]
},
"description": "The items to display in the references section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the references of the author."
}
},
"required": [
"profiles",
"experience",
"education",
"projects",
"languages",
"interests",
"awards",
"certifications",
"publications",
"volunteer",
"references"
],
"description": "Various sections of the resume, such as experience, education, projects, etc."
},
"customSections": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "cover-letter",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"recipient": {
"type": "string",
"description": "The recipient's address block as HTML (name, title, company, address, email)."
},
"content": {
"type": "string",
"description": "The cover letter body as HTML (salutation, paragraphs, closing, signature)."
}
},
"required": [
"id",
"hidden",
"recipient",
"content"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "summary",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"content": {
"type": "string",
"description": "The rich text content of the summary item. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"content"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "profiles",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"network": {
"type": "string",
"description": "The name of the network or platform. Empty while the entry is a draft, which isn't printed."
},
"username": {
"type": "string",
"description": "The username of the author on the network or platform."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the profile of the author on the network or platform, if any."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"network",
"username",
"website"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "experience",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"company": {
"type": "string",
"description": "The name of the company or organization. Empty while the entry is a draft, which isn't printed."
},
"position": {
"type": "string",
"description": "The position held at the company or organization. Used when there is only a single role. If multiple roles are provided in the 'roles' field, this serves as a summary title or can be left blank."
},
"location": {
"type": "string",
"description": "The location of the company or organization."
},
"period": {
"type": "string",
"description": "The overall period of time at the company, as text. When multiple roles are used, this should reflect the total tenure. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the company or organization, if any."
},
"description": {
"type": "string",
"description": "The description of the experience. This should be a HTML-formatted string."
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the role. Usually generated as a UUID."
},
"position": {
"type": "string",
"description": "The position or job title for this role."
},
"period": {
"type": "string",
"description": "The period of time this role was held, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"description": {
"type": "string",
"description": "The description of this specific role. This should be a HTML-formatted string."
}
},
"required": [
"id",
"position",
"period",
"description"
]
},
"description": "List of individual roles held at this company to show career progression."
}
},
"required": [
"id",
"hidden",
"company",
"position",
"location",
"period",
"website",
"description",
"roles"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "education",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"school": {
"type": "string",
"description": "The name of the school or institution. Empty while the entry is a draft, which isn't printed."
},
"degree": {
"type": "string",
"description": "The degree or qualification obtained."
},
"area": {
"type": "string",
"description": "The area of study or specialization."
},
"grade": {
"type": "string",
"description": "The grade or score achieved."
},
"location": {
"type": "string",
"description": "The location of the school or institution."
},
"period": {
"type": "string",
"description": "The period of time the education was obtained over, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the school or institution, if any."
},
"description": {
"type": "string",
"description": "The description of the education. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"school",
"degree",
"area",
"grade",
"location",
"period",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "projects",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"name": {
"type": "string",
"description": "The name of the project. Empty while the entry is a draft, which isn't printed."
},
"period": {
"type": "string",
"description": "The period of time the project was worked on, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the project, if any."
},
"description": {
"type": "string",
"description": "The description of the project. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"name",
"period",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"enum": [
"inline",
"list"
],
"type": "string",
"default": "inline",
"description": "How skill keywords are displayed: inline separated by commas, or one bullet per keyword."
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "skills",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"name": {
"type": "string",
"description": "The name of the skill. Empty while the entry is a draft, which isn't printed."
},
"proficiency": {
"type": "string",
"description": "The proficiency level of the skill. Can be any text, such as 'Beginner', 'Intermediate', 'Advanced', etc."
},
"level": {
"type": "number",
"minimum": 0,
"maximum": 5,
"description": "The proficiency level of the skill, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "The keywords associated with the skill, if any. These are displayed as tags below the name."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"name",
"proficiency",
"level",
"keywords"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "languages",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"language": {
"type": "string",
"description": "The name of the language the author knows. Empty while the entry is a draft, which isn't printed."
},
"fluency": {
"type": "string",
"description": "The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2)."
},
"level": {
"type": "number",
"minimum": 0,
"maximum": 5,
"description": "The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."
}
},
"required": [
"id",
"hidden",
"language",
"fluency",
"level"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "interests",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"name": {
"type": "string",
"description": "The name of the interest/hobby. Empty while the entry is a draft, which isn't printed."
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "The keywords associated with the interest/hobby, if any. These are displayed as tags below the name."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"name",
"keywords"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "awards",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the award. Empty while the entry is a draft, which isn't printed."
},
"awarder": {
"type": "string",
"description": "The awarder of the award."
},
"date": {
"type": "string",
"description": "The date when the award was received, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the award, if any."
},
"description": {
"type": "string",
"description": "The description of the award. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"awarder",
"date",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "certifications",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the certification. Empty while the entry is a draft, which isn't printed."
},
"issuer": {
"type": "string",
"description": "The issuer of the certification."
},
"date": {
"type": "string",
"description": "The date when the certification was received, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the certification, if any."
},
"description": {
"type": "string",
"description": "The description of the certification. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"issuer",
"date",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "publications",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the publication. Empty while the entry is a draft, which isn't printed."
},
"publisher": {
"type": "string",
"description": "The publisher of the publication."
},
"date": {
"type": "string",
"description": "The date when the publication was published, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the publication, if any."
},
"description": {
"type": "string",
"description": "The description of the publication. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"publisher",
"date",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "volunteer",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"organization": {
"type": "string",
"description": "The name of the organization or company. Empty while the entry is a draft, which isn't printed."
},
"location": {
"type": "string",
"description": "The location of the organization or company."
},
"period": {
"type": "string",
"description": "The period of time the author was volunteered at the organization or company, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the organization or company, if any."
},
"description": {
"type": "string",
"description": "The description of the volunteer experience. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"organization",
"location",
"period",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "references",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"name": {
"type": "string",
"description": "The name of the reference, or a note such as 'Available upon request'. Empty while the entry is a draft, which isn't printed."
},
"position": {
"type": "string",
"description": "The position or job title of the reference."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website or LinkedIn profile of the reference, if any."
},
"phone": {
"type": "string",
"description": "The phone number of the reference."
},
"description": {
"type": "string",
"description": "The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"name",
"position",
"website",
"phone",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
}
]
},
"description": "Custom sections of the resume, such as a custom section for notes, etc."
},
"metadata": {
"type": "object",
"properties": {
"template": {
"enum": [
"azurill",
"bronzor",
"chikorita",
"ditgar",
"ditto",
"gengar",
"glalie",
"kakuna",
"lapras",
"leafish",
"meowth",
"onyx",
"persian",
"pikachu",
"porygon",
"rhyhorn",
"scizor",
"smeargle"
],
"type": "string",
"description": "The template to use for the resume. Determines the overall design and appearance of the resume."
},
"layout": {
"type": "object",
"properties": {
"sidebarWidth": {
"type": "number",
"minimum": 10,
"maximum": 50,
"description": "The width of the sidebar column, defined as a percentage of the page width."
},
"sidebarSide": {
"enum": [
"left",
"right"
],
"type": "string",
"description": "Which side of the page the sidebar column sits on in two-column templates. When unset, each template uses its own side (and right-to-left resumes mirror it)."
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fullWidth": {
"type": "boolean",
"description": "Whether the layout of the page should be full width. If true, the main column will span the entire width of the page. This means that there should be no items in the sidebar column."
},
"main": {
"type": "array",
"items": {
"type": "string"
},
"description": "The items to display in the main column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."
},
"sidebar": {
"type": "array",
"items": {
"type": "string"
},
"description": "The items to display in the sidebar column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."
}
},
"required": [
"fullWidth",
"main",
"sidebar"
]
},
"description": "The pages to display in the layout."
}
},
"required": [
"sidebarWidth",
"pages"
],
"description": "The layout of the resume. Determines the structure and arrangement of the sections on the resume."
},
"page": {
"type": "object",
"properties": {
"gapX": {
"type": "number",
"minimum": 0,
"description": "The horizontal gap between the sections of the page, defined in points (pt)."
},
"gapY": {
"type": "number",
"minimum": 0,
"description": "The vertical gap between the sections of the page, defined in points (pt)."
},
"marginX": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "The horizontal margin of the page, defined in points (pt)."
},
"marginY": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "The vertical margin of the page, defined in points (pt)."
},
"format": {
"enum": [
"a4",
"letter",
"free-form"
],
"type": "string",
"description": "The format of the page. Can be 'a4', 'letter', or 'free-form'."
},
"locale": {
"type": "string",
"description": "The locale of the page. Used for displaying pre-translated section headings, if not overridden."
},
"dateFormat": {
"enum": [
"short",
"long",
"numeric",
"iso"
],
"type": "string",
"description": "How dates print: 'short' (Mar 2022), 'long' (March 2022), 'numeric' (03/2022) or 'iso' (2022-03). When missing, it's read from how the dates were typed."
},
"hideLinkUnderline": {
"type": "boolean",
"description": "Whether to hide the underlines of the links."
},
"hideIcons": {
"type": "boolean",
"description": "Whether to hide the item-level icons (skills, profiles, interests)."
},
"hideSectionIcons": {
"type": "boolean",
"description": "Whether to hide the section heading icons displayed before section titles."
}
},
"required": [
"gapX",
"gapY",
"marginX",
"marginY",
"format",
"locale",
"hideLinkUnderline",
"hideIcons",
"hideSectionIcons"
],
"description": "The page settings of the resume. Determines the margins, format, and locale of the resume."
},
"design": {
"type": "object",
"properties": {
"level": {
"type": "object",
"properties": {
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"type": {
"enum": [
"hidden",
"circle",
"square",
"rectangle",
"rectangle-full",
"progress-bar",
"icon"
],
"type": "string",
"description": "The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field."
}
},
"required": [
"icon",
"type"
]
},
"colors": {
"type": "object",
"properties": {
"primary": {
"type": "string",
"description": "The primary color of the design, defined as rgba(r, g, b, a)."
},
"text": {
"type": "string",
"description": "The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1)."
},
"background": {
"type": "string",
"description": "The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1)."
}
},
"required": [
"primary",
"text",
"background"
]
},
"entry": {
"type": "object",
"properties": {
"layout": {
"enum": [
"stacked",
"inline",
"compact",
"date-column",
"eyebrow"
],
"type": "string",
"description": "How the header of each Experience, Education and Volunteer entry is arranged. 'stacked' is two rows (name and location, then role and date), 'inline' puts everything on one row, 'compact' puts the lead and the date on top with the rest grouped below, 'date-column' sets dates in a column on the left, and 'eyebrow' puts a small line above a larger lead. Dates also move to the left column for Projects, Awards, Certifications and Publications with 'date-column'."
},
"lead": {
"enum": [
"organization",
"role"
],
"type": "string",
"description": "Which comes first in Experience and Education entries: the organization (company, school) or the role (position, field of study)."
},
"accent": {
"enum": [
"none",
"rule",
"bar",
"band"
],
"type": "string",
"description": "Decoration in the accent color around each entry header: 'none', 'rule' (a line under it), 'bar' (a bar beside it) or 'band' (a tinted background)."
}
},
"required": [
"layout",
"lead",
"accent"
],
"description": "How entry headers are arranged and decorated. When missing, entries use the stacked layout."
}
},
"required": [
"level",
"colors"
],
"description": "The design settings of the resume. Determines the colors, level designs, and typography of the resume."
},
"typography": {
"type": "object",
"properties": {
"body": {
"type": "object",
"properties": {
"fontFamily": {
"type": "string",
"description": "The family of the font to use. Must be a supported resume font."
},
"fontWeights": {
"type": "array",
"items": {
"enum": [
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900"
],
"type": "string"
},
"description": "The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."
},
"fontSize": {
"type": "number",
"minimum": 6,
"maximum": 24,
"description": "The size of the font to use, defined in points (pt)."
},
"lineHeight": {
"type": "number",
"minimum": 0.5,
"maximum": 4,
"description": "The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."
}
},
"required": [
"fontFamily",
"fontWeights",
"fontSize",
"lineHeight"
],
"description": "The typography for the body of the resume."
},
"heading": {
"type": "object",
"properties": {
"fontFamily": {
"type": "string",
"description": "The family of the font to use. Must be a supported resume font."
},
"fontWeights": {
"type": "array",
"items": {
"enum": [
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900"
],
"type": "string"
},
"description": "The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."
},
"fontSize": {
"type": "number",
"minimum": 6,
"maximum": 24,
"description": "The size of the font to use, defined in points (pt)."
},
"lineHeight": {
"type": "number",
"minimum": 0.5,
"maximum": 4,
"description": "The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."
}
},
"required": [
"fontFamily",
"fontWeights",
"fontSize",
"lineHeight"
],
"description": "The typography for the headings of the resume."
},
"hyphenation": {
"type": "boolean",
"description": "Enable automatic PDF hyphenation using the resume language. Defaults to false."
}
},
"required": [
"body",
"heading"
],
"description": "The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume."
},
"notes": {
"type": "string",
"description": "Personal notes for the resume. Can be used to add any additional information or instructions for the resume. These notes are not displayed on the resume, they are only visible to the author of the resume when editing the resume. This should be a HTML-formatted string."
},
"styleRules": {
"description": "Structured style rules that target semantic resume sections and slots for PDF rendering."
},
"stylesheet": {
"type": "object",
"properties": {
"mode": {
"enum": [
"legacy",
"semantic"
],
"type": "string"
},
"source": {
"type": "object",
"properties": {
"languageVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"text": {
"type": "string"
}
},
"required": [
"languageVersion",
"text"
],
"additionalProperties": false
}
},
"required": [
"mode",
"source"
],
"additionalProperties": false
},
"web": {
"type": "object",
"properties": {
"showCredit": {
"type": "boolean",
"description": "Whether the web page shows the small 'Made with Reactive Resume' footer."
}
},
"required": [
"showCredit"
],
"description": "Settings for the resume's public web page, which uses the resume's template. Missing until the author changes them in Share."
},
"check": {
"type": "object",
"properties": {
"ignored": {
"type": "array",
"items": {
"type": "string"
},
"description": "Check issues the author chose to ignore, by issue key (the rule code and where it applies)."
},
"hiddenTerms": {
"type": "array",
"items": {
"type": "string"
},
"description": "Job-posting terms the author hid from Job match as not true for them."
}
},
"required": [
"ignored",
"hiddenTerms"
],
"description": "The author's Check choices for this resume. Not printed; missing until a choice is made."
}
},
"required": [
"template",
"layout",
"page",
"design",
"typography",
"notes"
],
"description": "Metadata for the resume, such as template, layout, typography, etc. This section describes the overall design and appearance of the resume."
},
"aiOperationIds": {
"type": "array",
"maxItems": 1000,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
}
},
"required": [
"picture",
"basics",
"summary",
"sections",
"customSections",
"metadata"
],
"additionalProperties": {}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "The AI response wasn't in the expected format. Try again, or choose another model."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"502": {
"description": "502",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_GATEWAY"
},
"status": {
"const": 502
},
"message": {
"type": "string",
"default": "The AI provider returned an error or couldn't be reached. Try again, or check its settings."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/ai/parse-pdf\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"file\": {\n \"name\": \"<string>\",\n \"data\": \"<string>\"\n }\n}'"
}
]
}
},
"/ai/parse-docx": {
"post": {
"operationId": "parseResumeDocx",
"summary": "Parse a DOCX file into resume data",
"description": "Extracts structured resume data from a DOCX or DOC file with one of the user's saved AI providers: the one named by `aiProviderId`, or their default. Send the file as a base64-encoded string with the document's media type. Returns a complete ResumeData object and saves nothing.",
"deprecated": true,
"tags": [
"AI"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aiProviderId": {
"type": "string"
},
"file": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"data": {
"type": "string",
"maxLength": 13981018,
"contentEncoding": "base64"
}
},
"required": [
"name",
"data"
]
},
"includeProvenance": {
"type": "boolean"
},
"mediaType": {
"enum": [
"application/msword",
"application/vnd.openxmlformats-officedocument.wordprocessingml.document"
],
"type": "string"
}
},
"required": [
"file",
"mediaType"
]
}
}
}
},
"responses": {
"200": {
"description": "The DOCX was successfully parsed into structured resume data.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"picture": {
"type": "object",
"properties": {
"hidden": {
"type": "boolean",
"description": "Whether to hide the picture from the resume."
},
"fit": {
"enum": [
"cover",
"contain"
],
"type": "string",
"description": "How the picture fits its frame: cover crops overflow, while contain preserves the whole image."
},
"url": {
"type": "string",
"description": "The URL to the picture to display on the resume. Prefer local app-served paths (for example /uploads/...) populated via upload."
},
"size": {
"type": "number",
"minimum": 32,
"maximum": 512,
"description": "The size of the picture to display on the resume, defined in points (pt)."
},
"rotation": {
"type": "number",
"minimum": 0,
"maximum": 360,
"description": "The rotation of the picture to display on the resume, defined in degrees (°)."
},
"aspectRatio": {
"type": "number",
"minimum": 0.5,
"maximum": 2.5,
"description": "The aspect ratio of the picture to display on the resume, defined as width / height (e.g. 1.5 for 1.5:1 or 0.5 for 1:2)."
},
"borderRadius": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "The border radius of the picture to display on the resume, defined in points (pt)."
},
"borderColor": {
"type": "string",
"description": "The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a)."
},
"borderWidth": {
"type": "number",
"minimum": 0,
"description": "The width of the border of the picture to display on the resume, defined in points (pt)."
},
"shadowColor": {
"type": "string",
"description": "The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a)."
},
"shadowWidth": {
"type": "number",
"minimum": 0,
"description": "The width of the shadow of the picture to display on the resume, defined in points (pt)."
}
},
"required": [
"hidden",
"fit",
"url",
"size",
"rotation",
"aspectRatio",
"borderRadius",
"borderColor",
"borderWidth",
"shadowColor",
"shadowWidth"
],
"description": "Configuration for photograph displayed on the resume"
},
"basics": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full name of the author of the resume."
},
"headline": {
"type": "string",
"description": "The headline of the author of the resume."
},
"email": {
"type": "string",
"description": "The email address of the author of the resume."
},
"phone": {
"type": "string",
"description": "The phone number of the author of the resume."
},
"location": {
"type": "string",
"description": "The location of the author of the resume."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
}
},
"required": [
"url",
"label"
],
"description": "The website of the author of the resume."
},
"customFields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the custom field. Usually generated as a UUID."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"text": {
"type": "string",
"description": "The text to display for the custom field."
},
"link": {
"type": "string",
"description": "If the custom field should be a link, the URL to link to."
}
},
"required": [
"id",
"icon",
"text",
"link"
]
},
"description": "The custom fields to display on the resume."
}
},
"required": [
"name",
"headline",
"email",
"phone",
"location",
"website",
"customFields"
],
"description": "Basic information about the author, such as name, email, phone, location, and website"
},
"summary": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the summary of the resume."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the summary section title in the PDF output. Empty string uses the default summary icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the summary should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the summary from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the summary heading, icon, and decoration while retaining summary content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the summary is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the summary always begins on a new page."
},
"content": {
"type": "string",
"description": "The content of the summary of the resume. This should be a HTML-formatted string."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"content"
],
"description": "Summary section of the resume, useful for a short bio or introduction"
},
"sections": {
"type": "object",
"properties": {
"profiles": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"network": {
"type": "string",
"description": "The name of the network or platform. Empty while the entry is a draft, which isn't printed."
},
"username": {
"type": "string",
"description": "The username of the author on the network or platform."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the profile of the author on the network or platform, if any."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"network",
"username",
"website"
]
},
"description": "The items to display in the profiles section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the profiles of the author."
},
"experience": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"company": {
"type": "string",
"description": "The name of the company or organization. Empty while the entry is a draft, which isn't printed."
},
"position": {
"type": "string",
"description": "The position held at the company or organization. Used when there is only a single role. If multiple roles are provided in the 'roles' field, this serves as a summary title or can be left blank."
},
"location": {
"type": "string",
"description": "The location of the company or organization."
},
"period": {
"type": "string",
"description": "The overall period of time at the company, as text. When multiple roles are used, this should reflect the total tenure. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the company or organization, if any."
},
"description": {
"type": "string",
"description": "The description of the experience. This should be a HTML-formatted string."
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the role. Usually generated as a UUID."
},
"position": {
"type": "string",
"description": "The position or job title for this role."
},
"period": {
"type": "string",
"description": "The period of time this role was held, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"description": {
"type": "string",
"description": "The description of this specific role. This should be a HTML-formatted string."
}
},
"required": [
"id",
"position",
"period",
"description"
]
},
"description": "List of individual roles held at this company to show career progression."
}
},
"required": [
"id",
"hidden",
"company",
"position",
"location",
"period",
"website",
"description",
"roles"
]
},
"description": "The items to display in the experience section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the experience of the author."
},
"education": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"school": {
"type": "string",
"description": "The name of the school or institution. Empty while the entry is a draft, which isn't printed."
},
"degree": {
"type": "string",
"description": "The degree or qualification obtained."
},
"area": {
"type": "string",
"description": "The area of study or specialization."
},
"grade": {
"type": "string",
"description": "The grade or score achieved."
},
"location": {
"type": "string",
"description": "The location of the school or institution."
},
"period": {
"type": "string",
"description": "The period of time the education was obtained over, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the school or institution, if any."
},
"description": {
"type": "string",
"description": "The description of the education. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"school",
"degree",
"area",
"grade",
"location",
"period",
"website",
"description"
]
},
"description": "The items to display in the education section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the education of the author."
},
"projects": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"name": {
"type": "string",
"description": "The name of the project. Empty while the entry is a draft, which isn't printed."
},
"period": {
"type": "string",
"description": "The period of time the project was worked on, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the project, if any."
},
"description": {
"type": "string",
"description": "The description of the project. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"name",
"period",
"website",
"description"
]
},
"description": "The items to display in the projects section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the projects of the author."
},
"skills": {
"description": "The section to display the skills of the author."
},
"languages": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"language": {
"type": "string",
"description": "The name of the language the author knows. Empty while the entry is a draft, which isn't printed."
},
"fluency": {
"type": "string",
"description": "The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2)."
},
"level": {
"type": "number",
"minimum": 0,
"maximum": 5,
"description": "The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."
}
},
"required": [
"id",
"hidden",
"language",
"fluency",
"level"
]
},
"description": "The items to display in the languages section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the languages of the author."
},
"interests": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"name": {
"type": "string",
"description": "The name of the interest/hobby. Empty while the entry is a draft, which isn't printed."
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "The keywords associated with the interest/hobby, if any. These are displayed as tags below the name."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"name",
"keywords"
]
},
"description": "The items to display in the interests section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the interests of the author."
},
"awards": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the award. Empty while the entry is a draft, which isn't printed."
},
"awarder": {
"type": "string",
"description": "The awarder of the award."
},
"date": {
"type": "string",
"description": "The date when the award was received, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the award, if any."
},
"description": {
"type": "string",
"description": "The description of the award. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"awarder",
"date",
"website",
"description"
]
},
"description": "The items to display in the awards section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the awards of the author."
},
"certifications": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the certification. Empty while the entry is a draft, which isn't printed."
},
"issuer": {
"type": "string",
"description": "The issuer of the certification."
},
"date": {
"type": "string",
"description": "The date when the certification was received, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the certification, if any."
},
"description": {
"type": "string",
"description": "The description of the certification. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"issuer",
"date",
"website",
"description"
]
},
"description": "The items to display in the certifications section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the certifications of the author."
},
"publications": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the publication. Empty while the entry is a draft, which isn't printed."
},
"publisher": {
"type": "string",
"description": "The publisher of the publication."
},
"date": {
"type": "string",
"description": "The date when the publication was published, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the publication, if any."
},
"description": {
"type": "string",
"description": "The description of the publication. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"publisher",
"date",
"website",
"description"
]
},
"description": "The items to display in the publications section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the publications of the author."
},
"volunteer": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"organization": {
"type": "string",
"description": "The name of the organization or company. Empty while the entry is a draft, which isn't printed."
},
"location": {
"type": "string",
"description": "The location of the organization or company."
},
"period": {
"type": "string",
"description": "The period of time the author was volunteered at the organization or company, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the organization or company, if any."
},
"description": {
"type": "string",
"description": "The description of the volunteer experience. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"organization",
"location",
"period",
"website",
"description"
]
},
"description": "The items to display in the volunteer section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the volunteer experience of the author."
},
"references": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"name": {
"type": "string",
"description": "The name of the reference, or a note such as 'Available upon request'. Empty while the entry is a draft, which isn't printed."
},
"position": {
"type": "string",
"description": "The position or job title of the reference."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website or LinkedIn profile of the reference, if any."
},
"phone": {
"type": "string",
"description": "The phone number of the reference."
},
"description": {
"type": "string",
"description": "The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"name",
"position",
"website",
"phone",
"description"
]
},
"description": "The items to display in the references section."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"items"
],
"description": "The section to display the references of the author."
}
},
"required": [
"profiles",
"experience",
"education",
"projects",
"languages",
"interests",
"awards",
"certifications",
"publications",
"volunteer",
"references"
],
"description": "Various sections of the resume, such as experience, education, projects, etc."
},
"customSections": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "cover-letter",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"recipient": {
"type": "string",
"description": "The recipient's address block as HTML (name, title, company, address, email)."
},
"content": {
"type": "string",
"description": "The cover letter body as HTML (salutation, paragraphs, closing, signature)."
}
},
"required": [
"id",
"hidden",
"recipient",
"content"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "summary",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"content": {
"type": "string",
"description": "The rich text content of the summary item. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"content"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "profiles",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"network": {
"type": "string",
"description": "The name of the network or platform. Empty while the entry is a draft, which isn't printed."
},
"username": {
"type": "string",
"description": "The username of the author on the network or platform."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the profile of the author on the network or platform, if any."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"network",
"username",
"website"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "experience",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"company": {
"type": "string",
"description": "The name of the company or organization. Empty while the entry is a draft, which isn't printed."
},
"position": {
"type": "string",
"description": "The position held at the company or organization. Used when there is only a single role. If multiple roles are provided in the 'roles' field, this serves as a summary title or can be left blank."
},
"location": {
"type": "string",
"description": "The location of the company or organization."
},
"period": {
"type": "string",
"description": "The overall period of time at the company, as text. When multiple roles are used, this should reflect the total tenure. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the company or organization, if any."
},
"description": {
"type": "string",
"description": "The description of the experience. This should be a HTML-formatted string."
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the role. Usually generated as a UUID."
},
"position": {
"type": "string",
"description": "The position or job title for this role."
},
"period": {
"type": "string",
"description": "The period of time this role was held, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"description": {
"type": "string",
"description": "The description of this specific role. This should be a HTML-formatted string."
}
},
"required": [
"id",
"position",
"period",
"description"
]
},
"description": "List of individual roles held at this company to show career progression."
}
},
"required": [
"id",
"hidden",
"company",
"position",
"location",
"period",
"website",
"description",
"roles"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "education",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"school": {
"type": "string",
"description": "The name of the school or institution. Empty while the entry is a draft, which isn't printed."
},
"degree": {
"type": "string",
"description": "The degree or qualification obtained."
},
"area": {
"type": "string",
"description": "The area of study or specialization."
},
"grade": {
"type": "string",
"description": "The grade or score achieved."
},
"location": {
"type": "string",
"description": "The location of the school or institution."
},
"period": {
"type": "string",
"description": "The period of time the education was obtained over, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the school or institution, if any."
},
"description": {
"type": "string",
"description": "The description of the education. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"school",
"degree",
"area",
"grade",
"location",
"period",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "projects",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"name": {
"type": "string",
"description": "The name of the project. Empty while the entry is a draft, which isn't printed."
},
"period": {
"type": "string",
"description": "The period of time the project was worked on, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the project, if any."
},
"description": {
"type": "string",
"description": "The description of the project. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"name",
"period",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"enum": [
"inline",
"list"
],
"type": "string",
"default": "inline",
"description": "How skill keywords are displayed: inline separated by commas, or one bullet per keyword."
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "skills",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"name": {
"type": "string",
"description": "The name of the skill. Empty while the entry is a draft, which isn't printed."
},
"proficiency": {
"type": "string",
"description": "The proficiency level of the skill. Can be any text, such as 'Beginner', 'Intermediate', 'Advanced', etc."
},
"level": {
"type": "number",
"minimum": 0,
"maximum": 5,
"description": "The proficiency level of the skill, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "The keywords associated with the skill, if any. These are displayed as tags below the name."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"name",
"proficiency",
"level",
"keywords"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "languages",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"language": {
"type": "string",
"description": "The name of the language the author knows. Empty while the entry is a draft, which isn't printed."
},
"fluency": {
"type": "string",
"description": "The fluency level of the language. Can be any text, such as 'Native', 'Fluent', 'Conversational', etc. or can also be a CEFR level (A1, A2, B1, B2, C1, C2)."
},
"level": {
"type": "number",
"minimum": 0,
"maximum": 5,
"description": "The proficiency level of the language, defined as a number between 0 and 5. If set to 0, the icons displaying the level will be hidden."
}
},
"required": [
"id",
"hidden",
"language",
"fluency",
"level"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "interests",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"iconColor": {
"type": "string",
"description": "Custom color for the icon, defined as rgba(r, g, b, a). Leave blank to use the template default icon color."
},
"name": {
"type": "string",
"description": "The name of the interest/hobby. Empty while the entry is a draft, which isn't printed."
},
"keywords": {
"type": "array",
"items": {
"type": "string"
},
"description": "The keywords associated with the interest/hobby, if any. These are displayed as tags below the name."
}
},
"required": [
"id",
"hidden",
"icon",
"iconColor",
"name",
"keywords"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "awards",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the award. Empty while the entry is a draft, which isn't printed."
},
"awarder": {
"type": "string",
"description": "The awarder of the award."
},
"date": {
"type": "string",
"description": "The date when the award was received, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the award, if any."
},
"description": {
"type": "string",
"description": "The description of the award. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"awarder",
"date",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "certifications",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the certification. Empty while the entry is a draft, which isn't printed."
},
"issuer": {
"type": "string",
"description": "The issuer of the certification."
},
"date": {
"type": "string",
"description": "The date when the certification was received, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website of the certification, if any."
},
"description": {
"type": "string",
"description": "The description of the certification. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"issuer",
"date",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "publications",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"title": {
"type": "string",
"description": "The title of the publication. Empty while the entry is a draft, which isn't printed."
},
"publisher": {
"type": "string",
"description": "The publisher of the publication."
},
"date": {
"type": "string",
"description": "The date when the publication was published, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the publication, if any."
},
"description": {
"type": "string",
"description": "The description of the publication. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"title",
"publisher",
"date",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "volunteer",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"organization": {
"type": "string",
"description": "The name of the organization or company. Empty while the entry is a draft, which isn't printed."
},
"location": {
"type": "string",
"description": "The location of the organization or company."
},
"period": {
"type": "string",
"description": "The period of time the author was volunteered at the organization or company, as text. Written from `dates` on every save; write `dates` instead."
},
"dates": {
"type": "object",
"properties": {
"start": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it started, or the date itself for single-date entries (awards, certifications, publications)."
},
"end": {
"anyOf": [
{
"type": "string",
"pattern": "^\\d{4}(?:-(?:0[1-9]|1[0-2]))?$",
"description": "A year (\"2022\") or a year and month (\"2022-03\")."
},
{
"type": "null"
}
],
"description": "When it ended. Null while ongoing or for single dates."
},
"present": {
"type": "boolean",
"description": "Whether it's ongoing, printed as 'Present'."
},
"expected": {
"type": "boolean",
"description": "Whether the end date is still to come, such as a degree in progress: printed as 'Expected May 2027'. Ignored while present is true."
},
"raw": {
"type": "string",
"description": "Custom date text, also used for imported text that could not be read exactly. Printed verbatim, overriding start/end formatting. Preserve it when editing other fields; remove it only when the user chooses preset date fields."
}
},
"required": [
"start",
"end",
"present"
],
"description": "Structured dates. Write these rather than the legacy text field (`period` or `date`), which is kept in sync from them."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The link to the organization or company, if any."
},
"description": {
"type": "string",
"description": "The description of the volunteer experience. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"organization",
"location",
"period",
"website",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
},
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The title of the section."
},
"icon": {
"type": "string",
"description": "Phosphor icon name to display before the section title in the PDF output. Empty string uses the default section icon; 'none' hides the icon."
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The number of columns the section should span across."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the section from the resume."
},
"showHeading": {
"type": "boolean",
"description": "Whether to show the section heading, icon, and decoration while retaining section content."
},
"keepTogether": {
"type": "boolean",
"description": "If true, the section is kept on a single page instead of splitting across a page break."
},
"startOnNewPage": {
"type": "boolean",
"description": "If true, the section always begins on a new page."
},
"keywordLayout": {
"not": {}
},
"id": {
"type": "string",
"description": "The unique identifier for the custom section. Usually generated as a UUID."
},
"type": {
"const": "references",
"description": "The type of items this custom section contains. Determines which item schema and form fields to use."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the item. Usually generated as a UUID."
},
"hidden": {
"type": "boolean",
"description": "Whether to hide the item from the resume."
},
"name": {
"type": "string",
"description": "The name of the reference, or a note such as 'Available upon request'. Empty while the entry is a draft, which isn't printed."
},
"position": {
"type": "string",
"description": "The position or job title of the reference."
},
"website": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL to show as a link. Must be a valid URL with a protocol (http:// or https://)."
},
"label": {
"type": "string",
"description": "The label to display for the URL. Leave blank to display the URL as-is."
},
"inlineLink": {
"type": "boolean",
"description": "If true, the website URL is rendered as a hyperlink on the title instead of a separate link at the bottom."
}
},
"required": [
"url",
"label",
"inlineLink"
],
"description": "The website or LinkedIn profile of the reference, if any."
},
"phone": {
"type": "string",
"description": "The phone number of the reference."
},
"description": {
"type": "string",
"description": "The description of the reference. Can be used to display a quote, a testimonial, etc. This should be a HTML-formatted string."
}
},
"required": [
"id",
"hidden",
"name",
"position",
"website",
"phone",
"description"
],
"additionalProperties": {}
},
"description": "The items to display in the custom section. Items follow the schema of the section type."
}
},
"required": [
"title",
"icon",
"columns",
"hidden",
"keepTogether",
"startOnNewPage",
"id",
"type",
"items"
]
}
]
},
"description": "Custom sections of the resume, such as a custom section for notes, etc."
},
"metadata": {
"type": "object",
"properties": {
"template": {
"enum": [
"azurill",
"bronzor",
"chikorita",
"ditgar",
"ditto",
"gengar",
"glalie",
"kakuna",
"lapras",
"leafish",
"meowth",
"onyx",
"persian",
"pikachu",
"porygon",
"rhyhorn",
"scizor",
"smeargle"
],
"type": "string",
"description": "The template to use for the resume. Determines the overall design and appearance of the resume."
},
"layout": {
"type": "object",
"properties": {
"sidebarWidth": {
"type": "number",
"minimum": 10,
"maximum": 50,
"description": "The width of the sidebar column, defined as a percentage of the page width."
},
"sidebarSide": {
"enum": [
"left",
"right"
],
"type": "string",
"description": "Which side of the page the sidebar column sits on in two-column templates. When unset, each template uses its own side (and right-to-left resumes mirror it)."
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"fullWidth": {
"type": "boolean",
"description": "Whether the layout of the page should be full width. If true, the main column will span the entire width of the page. This means that there should be no items in the sidebar column."
},
"main": {
"type": "array",
"items": {
"type": "string"
},
"description": "The items to display in the main column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."
},
"sidebar": {
"type": "array",
"items": {
"type": "string"
},
"description": "The items to display in the sidebar column of the page. A string array of section IDs (experience, education, projects, skills, languages, interests, awards, certifications, publications, volunteer, references, profiles, summary or UUIDs for custom sections)."
}
},
"required": [
"fullWidth",
"main",
"sidebar"
]
},
"description": "The pages to display in the layout."
}
},
"required": [
"sidebarWidth",
"pages"
],
"description": "The layout of the resume. Determines the structure and arrangement of the sections on the resume."
},
"page": {
"type": "object",
"properties": {
"gapX": {
"type": "number",
"minimum": 0,
"description": "The horizontal gap between the sections of the page, defined in points (pt)."
},
"gapY": {
"type": "number",
"minimum": 0,
"description": "The vertical gap between the sections of the page, defined in points (pt)."
},
"marginX": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "The horizontal margin of the page, defined in points (pt)."
},
"marginY": {
"type": "number",
"minimum": 0,
"maximum": 100,
"description": "The vertical margin of the page, defined in points (pt)."
},
"format": {
"enum": [
"a4",
"letter",
"free-form"
],
"type": "string",
"description": "The format of the page. Can be 'a4', 'letter', or 'free-form'."
},
"locale": {
"type": "string",
"description": "The locale of the page. Used for displaying pre-translated section headings, if not overridden."
},
"dateFormat": {
"enum": [
"short",
"long",
"numeric",
"iso"
],
"type": "string",
"description": "How dates print: 'short' (Mar 2022), 'long' (March 2022), 'numeric' (03/2022) or 'iso' (2022-03). When missing, it's read from how the dates were typed."
},
"hideLinkUnderline": {
"type": "boolean",
"description": "Whether to hide the underlines of the links."
},
"hideIcons": {
"type": "boolean",
"description": "Whether to hide the item-level icons (skills, profiles, interests)."
},
"hideSectionIcons": {
"type": "boolean",
"description": "Whether to hide the section heading icons displayed before section titles."
}
},
"required": [
"gapX",
"gapY",
"marginX",
"marginY",
"format",
"locale",
"hideLinkUnderline",
"hideIcons",
"hideSectionIcons"
],
"description": "The page settings of the resume. Determines the margins, format, and locale of the resume."
},
"design": {
"type": "object",
"properties": {
"level": {
"type": "object",
"properties": {
"icon": {
"type": "string",
"description": "The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available."
},
"type": {
"enum": [
"hidden",
"circle",
"square",
"rectangle",
"rectangle-full",
"progress-bar",
"icon"
],
"type": "string",
"description": "The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field."
}
},
"required": [
"icon",
"type"
]
},
"colors": {
"type": "object",
"properties": {
"primary": {
"type": "string",
"description": "The primary color of the design, defined as rgba(r, g, b, a)."
},
"text": {
"type": "string",
"description": "The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1)."
},
"background": {
"type": "string",
"description": "The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1)."
}
},
"required": [
"primary",
"text",
"background"
]
},
"entry": {
"type": "object",
"properties": {
"layout": {
"enum": [
"stacked",
"inline",
"compact",
"date-column",
"eyebrow"
],
"type": "string",
"description": "How the header of each Experience, Education and Volunteer entry is arranged. 'stacked' is two rows (name and location, then role and date), 'inline' puts everything on one row, 'compact' puts the lead and the date on top with the rest grouped below, 'date-column' sets dates in a column on the left, and 'eyebrow' puts a small line above a larger lead. Dates also move to the left column for Projects, Awards, Certifications and Publications with 'date-column'."
},
"lead": {
"enum": [
"organization",
"role"
],
"type": "string",
"description": "Which comes first in Experience and Education entries: the organization (company, school) or the role (position, field of study)."
},
"accent": {
"enum": [
"none",
"rule",
"bar",
"band"
],
"type": "string",
"description": "Decoration in the accent color around each entry header: 'none', 'rule' (a line under it), 'bar' (a bar beside it) or 'band' (a tinted background)."
}
},
"required": [
"layout",
"lead",
"accent"
],
"description": "How entry headers are arranged and decorated. When missing, entries use the stacked layout."
}
},
"required": [
"level",
"colors"
],
"description": "The design settings of the resume. Determines the colors, level designs, and typography of the resume."
},
"typography": {
"type": "object",
"properties": {
"body": {
"type": "object",
"properties": {
"fontFamily": {
"type": "string",
"description": "The family of the font to use. Must be a supported resume font."
},
"fontWeights": {
"type": "array",
"items": {
"enum": [
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900"
],
"type": "string"
},
"description": "The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."
},
"fontSize": {
"type": "number",
"minimum": 6,
"maximum": 24,
"description": "The size of the font to use, defined in points (pt)."
},
"lineHeight": {
"type": "number",
"minimum": 0.5,
"maximum": 4,
"description": "The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."
}
},
"required": [
"fontFamily",
"fontWeights",
"fontSize",
"lineHeight"
],
"description": "The typography for the body of the resume."
},
"heading": {
"type": "object",
"properties": {
"fontFamily": {
"type": "string",
"description": "The family of the font to use. Must be a supported resume font."
},
"fontWeights": {
"type": "array",
"items": {
"enum": [
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900"
],
"type": "string"
},
"description": "The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font."
},
"fontSize": {
"type": "number",
"minimum": 6,
"maximum": 24,
"description": "The size of the font to use, defined in points (pt)."
},
"lineHeight": {
"type": "number",
"minimum": 0.5,
"maximum": 4,
"description": "The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x)."
}
},
"required": [
"fontFamily",
"fontWeights",
"fontSize",
"lineHeight"
],
"description": "The typography for the headings of the resume."
},
"hyphenation": {
"type": "boolean",
"description": "Enable automatic PDF hyphenation using the resume language. Defaults to false."
}
},
"required": [
"body",
"heading"
],
"description": "The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume."
},
"notes": {
"type": "string",
"description": "Personal notes for the resume. Can be used to add any additional information or instructions for the resume. These notes are not displayed on the resume, they are only visible to the author of the resume when editing the resume. This should be a HTML-formatted string."
},
"styleRules": {
"description": "Structured style rules that target semantic resume sections and slots for PDF rendering."
},
"stylesheet": {
"type": "object",
"properties": {
"mode": {
"enum": [
"legacy",
"semantic"
],
"type": "string"
},
"source": {
"type": "object",
"properties": {
"languageVersion": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"text": {
"type": "string"
}
},
"required": [
"languageVersion",
"text"
],
"additionalProperties": false
}
},
"required": [
"mode",
"source"
],
"additionalProperties": false
},
"web": {
"type": "object",
"properties": {
"showCredit": {
"type": "boolean",
"description": "Whether the web page shows the small 'Made with Reactive Resume' footer."
}
},
"required": [
"showCredit"
],
"description": "Settings for the resume's public web page, which uses the resume's template. Missing until the author changes them in Share."
},
"check": {
"type": "object",
"properties": {
"ignored": {
"type": "array",
"items": {
"type": "string"
},
"description": "Check issues the author chose to ignore, by issue key (the rule code and where it applies)."
},
"hiddenTerms": {
"type": "array",
"items": {
"type": "string"
},
"description": "Job-posting terms the author hid from Job match as not true for them."
}
},
"required": [
"ignored",
"hiddenTerms"
],
"description": "The author's Check choices for this resume. Not printed; missing until a choice is made."
}
},
"required": [
"template",
"layout",
"page",
"design",
"typography",
"notes"
],
"description": "Metadata for the resume, such as template, layout, typography, etc. This section describes the overall design and appearance of the resume."
},
"aiOperationIds": {
"type": "array",
"maxItems": 1000,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
}
},
"required": [
"picture",
"basics",
"summary",
"sections",
"customSections",
"metadata"
],
"additionalProperties": {}
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "The AI response wasn't in the expected format. Try again, or choose another model."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"502": {
"description": "502",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_GATEWAY"
},
"status": {
"const": 502
},
"message": {
"type": "string",
"default": "The AI provider returned an error or couldn't be reached. Try again, or check its settings."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/ai/parse-docx\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"file\": {\n \"name\": \"<string>\",\n \"data\": \"<string>\"\n },\n \"mediaType\": \"application/msword\"\n}'"
}
]
}
},
"/ai/ats-review": {
"post": {
"operationId": "atsReview",
"summary": "Review extracted resume text",
"description": "Reviews the plain text extracted from a resume PDF and returns qualitative feedback: a summary, rewrite suggestions, strengths, and — when a job description is supplied — how the candidate's experience lines up with the role. Deliberately returns no score: the deterministic ATS report owns the only number in this feature. Requires authentication and AI credentials.",
"deprecated": true,
"tags": [
"AI"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aiProviderId": {
"type": "string"
},
"resumeId": {
"type": "string"
},
"extractedText": {
"type": "string",
"minLength": 1,
"maxLength": 50000
},
"findings": {
"type": "array",
"maxItems": 120,
"items": {
"type": "object",
"properties": {
"code": {
"type": "string",
"maxLength": 64
},
"severity": {
"type": "string",
"maxLength": 16
},
"message": {
"type": "string",
"maxLength": 300
}
},
"required": [
"code",
"severity",
"message"
]
},
"default": []
},
"jobDescription": {
"type": "string",
"maxLength": 20000
},
"passages": {
"type": "array",
"maxItems": 120,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 16,
"description": "The client's id for the passage, echoed back as `passageId`."
},
"where": {
"type": "string",
"maxLength": 200,
"description": "Where the passage sits, e.g. “Experience · Lumen · bullet 2”."
},
"text": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"id",
"where",
"text"
]
},
"default": [],
"description": "Bullets and paragraphs the review may rewrite. A suggestion that rewrites one names it in `passageId`, with the whole new passage in `rewrite`."
}
},
"required": [
"extractedText"
]
}
}
}
},
"responses": {
"200": {
"description": "Qualitative review returned successfully.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"summary": {
"type": "string"
},
"suggestions": {},
"strengths": {},
"jdAlignment": {
"anyOf": [
{
"type": "object",
"properties": {
"verdict": {
"type": "string"
},
"missingConcepts": {},
"strengths": {}
},
"required": [
"verdict"
]
},
{
"type": "null"
}
]
}
},
"required": [
"summary",
"jdAlignment"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "The AI response wasn't in the expected format. Try again, or choose another model."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"502": {
"description": "502",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_GATEWAY"
},
"status": {
"const": 502
},
"message": {
"type": "string",
"default": "The AI provider returned an error or couldn't be reached. Try again, or check its settings."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/ai/ats-review\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"extractedText\": \"<string>\"\n}'"
}
]
}
},
"/ai/improve": {
"post": {
"operationId": "improveLine",
"summary": "Suggest a rewrite of one line",
"description": "Suggests a rewrite of one line of a resume or cover letter: a stronger verb, an added result, a shorter version, or the user's own request. Returns the new line, a short reason, and whether it states anything the input didn't, so the user can check it. Writes nothing. Requires authentication and AI credentials.",
"deprecated": true,
"tags": [
"AI"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aiProviderId": {
"type": "string"
},
"line": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"action": {
"enum": [
"verb",
"result",
"shorter",
"posting",
"warmer",
"custom"
],
"type": "string"
},
"request": {
"type": "string",
"maxLength": 500
},
"where": {
"type": "string",
"maxLength": 200,
"default": ""
},
"context": {
"type": "string",
"maxLength": 10000,
"default": ""
},
"applicationId": {
"type": "string"
},
"includeProvenance": {
"type": "boolean"
}
},
"required": [
"line",
"action"
]
}
}
}
},
"responses": {
"200": {
"description": "The suggested line.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1
},
"why": {
"type": "string"
},
"addsFacts": {
"type": "boolean"
},
"aiOperationIds": {
"type": "array",
"maxItems": 1000,
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
}
},
"aiUsage": {
"anyOf": [
{
"type": "object",
"properties": {
"requests": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"models": {
"type": "array",
"items": {
"type": "object",
"properties": {
"providerId": {
"type": "string"
},
"label": {
"type": "string"
},
"provider": {
"type": "string"
},
"model": {
"type": "string"
}
},
"required": [
"providerId",
"label",
"provider",
"model"
]
}
}
},
"required": [
"requests",
"models"
]
},
{
"type": "null"
}
]
}
},
"required": [
"text",
"why",
"addsFacts"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "The AI response wasn't in the expected format. Try again, or choose another model."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"502": {
"description": "502",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_GATEWAY"
},
"status": {
"const": 502
},
"message": {
"type": "string",
"default": "The AI provider returned an error or couldn't be reached. Try again, or check its settings."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/ai/improve\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"line\": \"<string>\",\n \"action\": \"verb\"\n}'"
}
]
}
},
"/ai-providers": {
"get": {
"operationId": "listAiProviders",
"summary": "List saved AI providers",
"description": "Lists saved provider/model/API key combinations for the authenticated user. API keys are redacted.",
"tags": [
"AI Providers"
],
"parameters": [
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results (1–100). Omit both pagination fields for the legacy complete list."
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Zero-based offset. Defaults to 0; limit defaults to 20 when only offset is given."
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"managed": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"provider": {
"enum": [
"openai",
"anthropic",
"gemini",
"vercel-ai-gateway",
"openrouter",
"mistral",
"cohere",
"xai",
"groq",
"deepseek",
"togetherai",
"fireworks",
"cerebras",
"perplexity",
"ollama",
"openai-compatible"
],
"type": "string"
},
"model": {
"type": "string"
},
"fastModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"capableModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"baseURL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"testStatus": {
"type": "string"
},
"testError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"testErrorKind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"apiKeyPreview": {
"type": "string"
},
"apiKeyFingerprint": {
"type": "string"
},
"recipientVersion": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"lastTestedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"managed",
"id",
"label",
"provider",
"model",
"fastModel",
"capableModel",
"baseURL",
"enabled",
"isDefault",
"testStatus",
"testError",
"testErrorKind",
"apiKeyPreview",
"apiKeyFingerprint",
"recipientVersion",
"lastTestedAt",
"lastUsedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"headers": {
"X-Total-Count": {
"description": "Total matching results before pagination.",
"schema": {
"type": "integer"
}
},
"X-Limit": {
"description": "Page size, when pagination is requested.",
"schema": {
"type": "integer"
}
},
"X-Offset": {
"description": "Zero-based offset, when pagination is requested.",
"schema": {
"type": "integer"
}
}
}
},
"412": {
"description": "412",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "PRECONDITION_FAILED"
},
"status": {
"const": 412
},
"message": {
"type": "string",
"default": "AI providers aren't available on this server. Ask the server administrator to set ENCRYPTION_SECRET."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/ai-providers\" --header \"x-api-key: <api-key>\""
}
]
},
"post": {
"operationId": "createAiProvider",
"summary": "Create saved AI provider",
"description": "Stores an encrypted provider/model/API key combination. The key is never returned.",
"tags": [
"AI Providers"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1
},
"provider": {
"enum": [
"openai",
"anthropic",
"gemini",
"vercel-ai-gateway",
"openrouter",
"mistral",
"cohere",
"xai",
"groq",
"deepseek",
"togetherai",
"fireworks",
"cerebras",
"perplexity",
"ollama",
"openai-compatible"
],
"type": "string"
},
"model": {
"type": "string",
"minLength": 1
},
"fastModel": {
"type": "string",
"maxLength": 200
},
"capableModel": {
"type": "string",
"maxLength": 200
},
"baseURL": {
"type": "string"
},
"apiKey": {
"type": "string"
}
},
"required": [
"label",
"provider",
"model",
"apiKey"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"managed": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"provider": {
"enum": [
"openai",
"anthropic",
"gemini",
"vercel-ai-gateway",
"openrouter",
"mistral",
"cohere",
"xai",
"groq",
"deepseek",
"togetherai",
"fireworks",
"cerebras",
"perplexity",
"ollama",
"openai-compatible"
],
"type": "string"
},
"model": {
"type": "string"
},
"fastModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"capableModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"baseURL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"testStatus": {
"type": "string"
},
"testError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"testErrorKind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"apiKeyPreview": {
"type": "string"
},
"apiKeyFingerprint": {
"type": "string"
},
"recipientVersion": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"lastTestedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"managed",
"id",
"label",
"provider",
"model",
"fastModel",
"capableModel",
"baseURL",
"enabled",
"isDefault",
"testStatus",
"testError",
"testErrorKind",
"apiKeyPreview",
"apiKeyFingerprint",
"recipientVersion",
"lastTestedAt",
"lastUsedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "That provider setup isn't valid. Check the base URL and try again."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "AI is set up by the server administrator and can't be changed here."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"412": {
"description": "412",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "PRECONDITION_FAILED"
},
"status": {
"const": 412
},
"message": {
"type": "string",
"default": "AI providers aren't available on this server. Ask the server administrator to set ENCRYPTION_SECRET."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/ai-providers\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"label\": \"<string>\",\n \"provider\": \"openai\",\n \"model\": \"<string>\",\n \"apiKey\": \"<string>\"\n}'"
}
]
}
},
"/ai-providers/{id}": {
"patch": {
"operationId": "updateAiProvider",
"summary": "Update saved AI provider",
"description": "Updates a saved provider/model/API key combination. Updating the key requires retesting before use.",
"tags": [
"AI Providers"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"label": {
"type": "string",
"minLength": 1
},
"provider": {
"enum": [
"openai",
"anthropic",
"gemini",
"vercel-ai-gateway",
"openrouter",
"mistral",
"cohere",
"xai",
"groq",
"deepseek",
"togetherai",
"fireworks",
"cerebras",
"perplexity",
"ollama",
"openai-compatible"
],
"type": "string"
},
"model": {
"type": "string",
"minLength": 1
},
"fastModel": {
"type": "string",
"maxLength": 200
},
"capableModel": {
"type": "string",
"maxLength": 200
},
"baseURL": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"enabled": {
"type": "boolean"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"managed": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"provider": {
"enum": [
"openai",
"anthropic",
"gemini",
"vercel-ai-gateway",
"openrouter",
"mistral",
"cohere",
"xai",
"groq",
"deepseek",
"togetherai",
"fireworks",
"cerebras",
"perplexity",
"ollama",
"openai-compatible"
],
"type": "string"
},
"model": {
"type": "string"
},
"fastModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"capableModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"baseURL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"testStatus": {
"type": "string"
},
"testError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"testErrorKind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"apiKeyPreview": {
"type": "string"
},
"apiKeyFingerprint": {
"type": "string"
},
"recipientVersion": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"lastTestedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"managed",
"id",
"label",
"provider",
"model",
"fastModel",
"capableModel",
"baseURL",
"enabled",
"isDefault",
"testStatus",
"testError",
"testErrorKind",
"apiKeyPreview",
"apiKeyFingerprint",
"recipientVersion",
"lastTestedAt",
"lastUsedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "That provider setup isn't valid. Check the base URL and try again."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "AI is set up by the server administrator and can't be changed here."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "This AI provider no longer exists. Reload and choose another provider."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"412": {
"description": "412",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "PRECONDITION_FAILED"
},
"status": {
"const": 412
},
"message": {
"type": "string",
"default": "AI providers aren't available on this server. Ask the server administrator to set ENCRYPTION_SECRET."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PATCH \"https://rxresu.me/api/openapi/ai-providers/<id>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{}'"
}
]
},
"delete": {
"operationId": "deleteAiProvider",
"summary": "Delete saved AI provider",
"description": "Deletes a saved provider/model/API key combination.",
"tags": [
"AI Providers"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "AI is set up by the server administrator and can't be changed here."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"412": {
"description": "412",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "PRECONDITION_FAILED"
},
"status": {
"const": 412
},
"message": {
"type": "string",
"default": "AI providers aren't available on this server. Ask the server administrator to set ENCRYPTION_SECRET."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/ai-providers/<id>\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/ai-providers/{id}/default": {
"post": {
"operationId": "setDefaultAiProvider",
"summary": "Make an AI provider the default",
"description": "Makes a tested, enabled provider the one used whenever no provider is chosen. The previous default stops being one.",
"tags": [
"AI Providers"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"managed": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"provider": {
"enum": [
"openai",
"anthropic",
"gemini",
"vercel-ai-gateway",
"openrouter",
"mistral",
"cohere",
"xai",
"groq",
"deepseek",
"togetherai",
"fireworks",
"cerebras",
"perplexity",
"ollama",
"openai-compatible"
],
"type": "string"
},
"model": {
"type": "string"
},
"fastModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"capableModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"baseURL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"testStatus": {
"type": "string"
},
"testError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"testErrorKind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"apiKeyPreview": {
"type": "string"
},
"apiKeyFingerprint": {
"type": "string"
},
"recipientVersion": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"lastTestedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"managed",
"id",
"label",
"provider",
"model",
"fastModel",
"capableModel",
"baseURL",
"enabled",
"isDefault",
"testStatus",
"testError",
"testErrorKind",
"apiKeyPreview",
"apiKeyFingerprint",
"recipientVersion",
"lastTestedAt",
"lastUsedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "Test and turn on this provider before making it the default."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "AI is set up by the server administrator and can't be changed here."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "This AI provider no longer exists. Reload and choose another provider."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"412": {
"description": "412",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "PRECONDITION_FAILED"
},
"status": {
"const": 412
},
"message": {
"type": "string",
"default": "AI providers aren't available on this server. Ask the server administrator to set ENCRYPTION_SECRET."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/ai-providers/<id>/default\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/ai-providers/{id}/test": {
"post": {
"operationId": "testAiProvider",
"summary": "Test saved AI provider",
"description": "Decrypts the saved API key server-side and validates the provider/model connection.",
"deprecated": true,
"tags": [
"AI Providers"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"managed": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"provider": {
"enum": [
"openai",
"anthropic",
"gemini",
"vercel-ai-gateway",
"openrouter",
"mistral",
"cohere",
"xai",
"groq",
"deepseek",
"togetherai",
"fireworks",
"cerebras",
"perplexity",
"ollama",
"openai-compatible"
],
"type": "string"
},
"model": {
"type": "string"
},
"fastModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"capableModel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"baseURL": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"isDefault": {
"type": "boolean"
},
"testStatus": {
"type": "string"
},
"testError": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"testErrorKind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"apiKeyPreview": {
"type": "string"
},
"apiKeyFingerprint": {
"type": "string"
},
"recipientVersion": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"lastTestedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"lastUsedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"managed",
"id",
"label",
"provider",
"model",
"fastModel",
"capableModel",
"baseURL",
"enabled",
"isDefault",
"testStatus",
"testError",
"testErrorKind",
"apiKeyPreview",
"apiKeyFingerprint",
"recipientVersion",
"lastTestedAt",
"lastUsedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "That provider setup isn't valid. Check the base URL and try again."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"403": {
"description": "403",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "FORBIDDEN"
},
"status": {
"const": 403
},
"message": {
"type": "string",
"default": "AI is set up by the server administrator and can't be changed here."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"404": {
"description": "404",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "NOT_FOUND"
},
"status": {
"const": 404
},
"message": {
"type": "string",
"default": "This AI provider no longer exists. Reload and choose another provider."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"412": {
"description": "412",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "PRECONDITION_FAILED"
},
"status": {
"const": 412
},
"message": {
"type": "string",
"default": "AI providers aren't available on this server. Ask the server administrator to set ENCRYPTION_SECRET."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"502": {
"description": "502",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_GATEWAY"
},
"status": {
"const": 502
},
"message": {
"type": "string",
"default": "The AI provider returned an error or couldn't be reached. Try again, or check its settings."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/ai-providers/<id>/test\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/agent/threads": {
"get": {
"operationId": "listAgentThreads",
"summary": "List agent threads",
"tags": [
"Agent"
],
"parameters": [
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results (1–100). Omit both pagination fields for the legacy complete list."
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Zero-based offset. Defaults to 0; limit defaults to 20 when only offset is given."
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"firstMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"scope": {
"enum": [
"document",
"application",
"career"
],
"type": "string"
},
"applicationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceResumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workingResumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"aiProviderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"providerLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"editsProposed": {
"type": "number"
},
"editsAccepted": {
"type": "number"
},
"activeRunId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastMessageAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"archivedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"deletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"title",
"status",
"scope",
"applicationId",
"sourceResumeId",
"workingResumeId",
"coverLetterId",
"aiProviderId",
"resumeName",
"coverLetterName",
"providerLabel",
"editsProposed",
"editsAccepted",
"activeRunId",
"lastMessageAt",
"archivedAt",
"deletedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"headers": {
"X-Total-Count": {
"description": "Total matching results before pagination.",
"schema": {
"type": "integer"
}
},
"X-Limit": {
"description": "Page size, when pagination is requested.",
"schema": {
"type": "integer"
}
},
"X-Offset": {
"description": "Zero-based offset, when pagination is requested.",
"schema": {
"type": "integer"
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/agent/threads\" --header \"x-api-key: <api-key>\""
}
]
},
"post": {
"operationId": "startAgentThread",
"summary": "Start a document, application or career conversation",
"description": "Starts an assistant conversation about one resume or cover letter, using the given tested provider or the default one. The assistant reads the document and proposes edits; it never changes the document itself.",
"tags": [
"Agent"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"resumeId": {
"type": "string",
"minLength": 1
},
"coverLetterId": {
"type": "string",
"minLength": 1
},
"aiProviderId": {
"type": "string"
},
"scope": {
"enum": [
"document",
"application",
"career"
],
"type": "string",
"default": "document"
},
"applicationId": {
"type": "string",
"minLength": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"firstMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"scope": {
"enum": [
"document",
"application",
"career"
],
"type": "string"
},
"applicationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceResumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workingResumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"aiProviderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"providerLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"editsProposed": {
"type": "number"
},
"editsAccepted": {
"type": "number"
},
"activeRunId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastMessageAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"archivedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"deletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"title",
"status",
"scope",
"applicationId",
"sourceResumeId",
"workingResumeId",
"coverLetterId",
"aiProviderId",
"resumeName",
"coverLetterName",
"providerLabel",
"editsProposed",
"editsAccepted",
"activeRunId",
"lastMessageAt",
"archivedAt",
"deletedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/agent/threads\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{}'"
}
]
}
},
"/agent/threads/{id}": {
"get": {
"operationId": "getAgentThread",
"summary": "Get agent thread",
"tags": [
"Agent"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"thread": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"firstMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"scope": {
"enum": [
"document",
"application",
"career"
],
"type": "string"
},
"applicationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceResumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workingResumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"aiProviderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"providerLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"editsProposed": {
"type": "number"
},
"editsAccepted": {
"type": "number"
},
"activeRunId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastMessageAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"archivedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"deletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"title",
"status",
"scope",
"applicationId",
"sourceResumeId",
"workingResumeId",
"coverLetterId",
"aiProviderId",
"resumeName",
"coverLetterName",
"providerLabel",
"editsProposed",
"editsAccepted",
"activeRunId",
"lastMessageAt",
"archivedAt",
"deletedAt",
"createdAt",
"updatedAt"
]
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"system",
"user",
"assistant"
],
"type": "string"
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": {}
}
},
"metadata": {}
},
"required": [
"id",
"role",
"parts"
]
}
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"threadId": {
"type": "string"
},
"messageId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"filename": {
"type": "string"
},
"mediaType": {
"type": "string"
},
"size": {
"type": "number"
},
"storagePath": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"threadId",
"messageId",
"filename",
"mediaType",
"size",
"createdAt"
]
}
},
"document": {
"anyOf": [
{
"type": "object",
"properties": {
"kind": {
"enum": [
"resume",
"letter"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"locked": {
"type": "boolean"
}
},
"required": [
"kind",
"id",
"name",
"locked"
]
},
{
"type": "null"
}
]
},
"isReadOnly": {
"type": "boolean"
},
"history": {
"type": "object",
"properties": {
"cutoffAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"withheld": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"cutoffAt",
"withheld"
]
},
"interrupted": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"thread",
"messages",
"attachments",
"document",
"isReadOnly"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/agent/threads/<id>\" --header \"x-api-key: <api-key>\""
}
]
},
"patch": {
"operationId": "updateAgentThread",
"summary": "Switch a conversation's model or rename it",
"tags": [
"Agent"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"aiProviderId": {
"type": "string",
"minLength": 1
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"firstMessage": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"scope": {
"enum": [
"document",
"application",
"career"
],
"type": "string"
},
"applicationId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceResumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"workingResumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"aiProviderId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"providerLabel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"editsProposed": {
"type": "number"
},
"editsAccepted": {
"type": "number"
},
"activeRunId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"lastMessageAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"archivedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"deletedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"title",
"status",
"scope",
"applicationId",
"sourceResumeId",
"workingResumeId",
"coverLetterId",
"aiProviderId",
"resumeName",
"coverLetterName",
"providerLabel",
"editsProposed",
"editsAccepted",
"activeRunId",
"lastMessageAt",
"archivedAt",
"deletedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PATCH \"https://rxresu.me/api/openapi/agent/threads/<id>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{}'"
}
]
},
"delete": {
"operationId": "deleteAgentThread",
"summary": "Delete agent thread",
"tags": [
"Agent"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/agent/threads/<id>\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/agent/messages/send": {
"post": {
"operationId": "sendAgentMessage",
"summary": "Send agent message",
"deprecated": true,
"tags": [
"Agent"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"threadId": {
"type": "string"
},
"message": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"system",
"user",
"assistant"
],
"type": "string"
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": {}
}
},
"metadata": {}
},
"required": [
"id",
"role",
"parts"
]
},
"attachmentIds": {
"type": "array",
"maxItems": 10,
"items": {
"type": "string",
"minLength": 1
}
},
"context": {
"type": "object",
"properties": {
"document": {
"type": "boolean",
"description": "Share the open document (on by default)."
},
"posting": {
"type": "boolean",
"description": "Share the job posting it's for (on by default)."
},
"application": {
"type": "boolean",
"description": "Career coach: share the application (or summaries of all of them) and the documents sent."
},
"memory": {
"type": "boolean",
"description": "Career coach: share switched-on facts, stories and preferences (on by default). Document conversations: let the assistant search shared facts and stories, read-only (off by default)."
},
"web": {
"type": "boolean",
"description": "Career coach: let the coach search public pages through the web search service (off by default)."
},
"tab": {
"enum": [
"fit",
"apply",
"prepare",
"practise",
"debrief",
"messages",
"saved"
],
"type": "string",
"description": "Career coach: the workspace tab the user is on, as a hint."
},
"offerIds": {
"type": "array",
"maxItems": 2,
"items": {
"type": "string",
"minLength": 1
},
"description": "Career coach: saved offers to compare (Plan what to ask)."
},
"applicationId": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
}
},
"required": [
"threadId",
"message"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/event-stream": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"event": {
"const": "message"
},
"data": {
"type": "string"
},
"id": {
"type": "string"
},
"retry": {
"type": "number"
}
},
"required": [
"event",
"data"
]
},
{
"type": "object",
"properties": {
"event": {
"const": "done"
},
"data": {},
"id": {
"type": "string"
},
"retry": {
"type": "number"
}
},
"required": [
"event"
]
},
{
"type": "object",
"properties": {
"event": {
"const": "error"
},
"data": {},
"id": {
"type": "string"
},
"retry": {
"type": "number"
}
},
"required": [
"event"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/agent/messages/send\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"threadId\": \"<string>\",\n \"message\": {\n \"id\": \"<string>\",\n \"role\": \"system\",\n \"parts\": [\n {\n \"type\": \"<string>\"\n }\n ]\n }\n}'"
}
]
}
},
"/agent/messages/stop": {
"post": {
"operationId": "stopAgentMessage",
"summary": "Stop active agent run",
"deprecated": true,
"tags": [
"Agent"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"threadId": {
"type": "string"
},
"partialMessage": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"role": {
"enum": [
"system",
"user",
"assistant"
],
"type": "string"
},
"parts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string"
}
},
"required": [
"type"
],
"additionalProperties": {}
}
},
"metadata": {}
},
"required": [
"id",
"role",
"parts"
]
}
},
"required": [
"threadId"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/agent/messages/stop\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"threadId\": \"<string>\"\n}'"
}
]
}
},
"/agent/messages/resume": {
"get": {
"operationId": "resumeAgentMessages",
"summary": "Resume agent message stream",
"deprecated": true,
"tags": [
"Agent"
],
"parameters": [
{
"name": "threadId",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/event-stream": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"event": {
"const": "message"
},
"data": {
"type": "string"
},
"id": {
"type": "string"
},
"retry": {
"type": "number"
}
},
"required": [
"event",
"data"
]
},
{
"type": "object",
"properties": {
"event": {
"const": "done"
},
"data": {},
"id": {
"type": "string"
},
"retry": {
"type": "number"
}
},
"required": [
"event"
]
},
{
"type": "object",
"properties": {
"event": {
"const": "error"
},
"data": {},
"id": {
"type": "string"
},
"retry": {
"type": "number"
}
},
"required": [
"event"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/agent/messages/resume?threadId=<threadId>\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/agent/messages/edit-status": {
"post": {
"operationId": "setAgentEditStatus",
"summary": "Record what happened to proposed edits",
"description": "Records that proposed edits were accepted, rejected, rewritten by the user, or are pending again (after an undo), so past conversations show their outcome.",
"deprecated": true,
"tags": [
"Agent"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"threadId": {
"type": "string"
},
"messageId": {
"type": "string"
},
"toolCallId": {
"type": "string"
},
"edits": {
"type": "array",
"minItems": 1,
"maxItems": 50,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"pending",
"accepted",
"rejected"
],
"type": "string"
},
"text": {
"type": "string",
"minLength": 1,
"maxLength": 2000,
"description": "The user's own wording for the edit's new text, in plain text, when they rewrote it."
},
"after": {
"type": "string",
"maxLength": 50000,
"description": "The edit's new text (after) as the client showed it. When given, the decision is refused if the edit has since been reworded elsewhere; apply it to the document only after this succeeds."
}
},
"required": [
"id",
"status"
]
}
}
},
"required": [
"threadId",
"messageId",
"toolCallId",
"edits"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"editsProposed": {
"type": "number"
},
"editsAccepted": {
"type": "number"
}
},
"required": [
"editsProposed",
"editsAccepted"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/agent/messages/edit-status\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"threadId\": \"<string>\",\n \"messageId\": \"<string>\",\n \"toolCallId\": \"<string>\",\n \"edits\": [\n {\n \"id\": \"<string>\",\n \"status\": \"pending\"\n }\n ]\n}'"
}
]
}
},
"/agent/attachments": {
"post": {
"operationId": "createAgentAttachment",
"summary": "Create agent attachment",
"tags": [
"Agent"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"threadId": {
"type": "string"
},
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"mediaType": {
"type": "string",
"maxLength": 255,
"pattern": "^[\\w.+-]+\\/[\\w.+-]+$"
},
"data": {
"type": "string",
"minLength": 1,
"maxLength": 34952536,
"contentEncoding": "base64"
}
},
"required": [
"threadId",
"filename",
"mediaType",
"data"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"threadId": {
"type": "string"
},
"messageId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"filename": {
"type": "string"
},
"mediaType": {
"type": "string"
},
"size": {
"type": "number"
},
"storagePath": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"threadId",
"messageId",
"filename",
"mediaType",
"size",
"createdAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/agent/attachments\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"threadId\": \"<string>\",\n \"filename\": \"<string>\",\n \"mediaType\": \"<string>\",\n \"data\": \"<string>\"\n}'"
}
]
}
},
"/agent/attachments/{id}": {
"delete": {
"operationId": "deleteAgentAttachment",
"summary": "Delete agent attachment",
"tags": [
"Agent"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/agent/attachments/<id>\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/applications/trash": {
"get": {
"operationId": "listTrashedApplications",
"summary": "List applications in Trash",
"tags": [
"Applications"
],
"parameters": [
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results (1–100). Omit both pagination fields for the legacy complete list."
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Zero-based offset. Defaults to 0; limit defaults to 20 when only offset is given."
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"company": {
"type": "string"
},
"role": {
"type": "string"
},
"trashedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"id",
"company",
"role",
"trashedAt"
]
}
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"items",
"total"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/applications/trash\" --header \"x-api-key: <api-key>\""
}
]
},
"post": {
"operationId": "trashApplications",
"summary": "Move applications to Trash",
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"items": {
"type": "string"
}
}
},
"required": [
"ids"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted": {
"type": "number"
}
},
"required": [
"deleted"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/trash\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"ids\": [\n \"<string>\"\n ]\n}'"
}
]
}
},
"/applications/{id}/trash": {
"post": {
"operationId": "trashApplication",
"summary": "Move an application to Trash",
"description": "Retains the timeline, relationships and files until explicitly permanently deleted. Restore from Trash after reload.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The ID of the application."
}
}
],
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/<id>/trash\" --header \"x-api-key: <api-key>\""
}
]
},
"delete": {
"operationId": "purgeApplication",
"summary": "Permanently delete an application from Trash",
"description": "Permanently removes only the listed Trash generation. Refuses a restored or re-trashed application. Linked resumes and letters are kept.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"trashedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"trashedAt"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/applications/<id>/trash\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"trashedAt\": \"<string>\"\n}'"
}
]
}
},
"/applications/{id}/restore": {
"post": {
"operationId": "restoreApplication",
"summary": "Restore an application from Trash",
"description": "Restores the retained application, timeline and relationships. Requires the timestamp returned by listTrashedApplications; a stale Trash action is refused.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"trashedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
}
},
"required": [
"trashedAt"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/<id>/restore\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"trashedAt\": \"<string>\"\n}'"
}
]
}
},
"/applications/{applicationId}/packet-review": {
"post": {
"operationId": "reviewApplicationPacket",
"summary": "Review an owned application packet without AI or submission",
"tags": [
"Applications"
],
"parameters": [
{
"name": "applicationId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"minLength": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"targetUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"includeContact": {
"type": "boolean"
},
"answerIds": {
"type": "array",
"maxItems": 20,
"items": {
"type": "string",
"minLength": 1
}
},
"letterWords": {
"anyOf": [
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"maxLength": 50
},
"greeting": {
"type": "string",
"maxLength": 500
},
"teamGreeting": {
"type": "string",
"maxLength": 500
},
"hiringTeam": {
"type": "string",
"maxLength": 500
},
"signOff": {
"type": "string",
"maxLength": 500
}
},
"required": [
"locale",
"greeting",
"teamGreeting",
"hiringTeam",
"signOff"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"targetUrl",
"includeContact",
"answerIds"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"selection": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
},
"targetUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"includeContact": {
"type": "boolean"
},
"answerIds": {
"type": "array",
"maxItems": 20,
"items": {
"type": "string",
"minLength": 1
}
},
"letterWords": {
"anyOf": [
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"maxLength": 50
},
"greeting": {
"type": "string",
"maxLength": 500
},
"teamGreeting": {
"type": "string",
"maxLength": 500
},
"hiringTeam": {
"type": "string",
"maxLength": 500
},
"signOff": {
"type": "string",
"maxLength": 500
}
},
"required": [
"locale",
"greeting",
"teamGreeting",
"hiringTeam",
"signOff"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"applicationId",
"targetUrl",
"includeContact",
"answerIds"
],
"additionalProperties": false
},
"fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"application": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"company": {
"type": "string"
},
"role": {
"type": "string"
}
},
"required": [
"id",
"company",
"role"
],
"additionalProperties": false
},
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"givenName": {
"type": "string",
"maxLength": 200
},
"familyName": {
"type": "string",
"maxLength": 200
},
"email": {
"type": "string",
"maxLength": 320
},
"phone": {
"type": "string",
"maxLength": 200
}
},
"required": [
"givenName",
"familyName",
"email",
"phone"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"profileRevision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profileReviewedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"experience": {
"type": "string",
"maxLength": 30000
},
"letterText": {
"type": "string",
"maxLength": 130000
},
"answers": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"question": {
"type": "string",
"maxLength": 2000
},
"answer": {
"type": "string",
"maxLength": 6000
},
"source": {
"enum": [
"manual",
"application",
"ai-assisted"
],
"type": "string"
},
"scope": {
"enum": [
"application",
"employer",
"reusable"
],
"type": "string"
},
"reviewedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"revision",
"question",
"answer",
"source",
"scope",
"reviewedAt"
],
"additionalProperties": false
}
},
"documents": {
"type": "array",
"maxItems": 2,
"items": {
"type": "object",
"properties": {
"kind": {
"enum": [
"resume",
"letter"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"revision": {
"type": "string"
}
},
"required": [
"kind",
"id",
"name",
"revision"
],
"additionalProperties": false
}
}
},
"required": [
"selection",
"fingerprint",
"application",
"contact",
"profileRevision",
"profileReviewedAt",
"experience",
"letterText",
"answers",
"documents"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/<applicationId>/packet-review\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"targetUrl\": \"<string>\",\n \"includeContact\": true,\n \"answerIds\": [\n \"<string>\"\n ]\n}'"
}
]
}
},
"/applications/packets": {
"post": {
"operationId": "exportApplicationPacket",
"summary": "Export explicitly reviewed PDF versions and scoped answers; never submit",
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"selection": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
},
"targetUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"includeContact": {
"type": "boolean"
},
"answerIds": {
"type": "array",
"maxItems": 20,
"items": {
"type": "string",
"minLength": 1
}
},
"letterWords": {
"anyOf": [
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"maxLength": 50
},
"greeting": {
"type": "string",
"maxLength": 500
},
"teamGreeting": {
"type": "string",
"maxLength": 500
},
"hiringTeam": {
"type": "string",
"maxLength": 500
},
"signOff": {
"type": "string",
"maxLength": 500
}
},
"required": [
"locale",
"greeting",
"teamGreeting",
"hiringTeam",
"signOff"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"applicationId",
"targetUrl",
"includeContact",
"answerIds"
],
"additionalProperties": false
},
"fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"reviewed": {
"const": true
}
},
"required": [
"selection",
"fingerprint",
"reviewed"
],
"additionalProperties": false
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"format": {
"const": "reactive-resume-application-packet"
},
"version": {
"const": 1
},
"approvedAt": {
"type": "string",
"format": "date-time"
},
"review": {
"type": "object",
"properties": {
"selection": {
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"minLength": 1
},
"targetUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
},
"includeContact": {
"type": "boolean"
},
"answerIds": {
"type": "array",
"maxItems": 20,
"items": {
"type": "string",
"minLength": 1
}
},
"letterWords": {
"anyOf": [
{
"type": "object",
"properties": {
"locale": {
"type": "string",
"maxLength": 50
},
"greeting": {
"type": "string",
"maxLength": 500
},
"teamGreeting": {
"type": "string",
"maxLength": 500
},
"hiringTeam": {
"type": "string",
"maxLength": 500
},
"signOff": {
"type": "string",
"maxLength": 500
}
},
"required": [
"locale",
"greeting",
"teamGreeting",
"hiringTeam",
"signOff"
],
"additionalProperties": false
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"applicationId",
"targetUrl",
"includeContact",
"answerIds"
],
"additionalProperties": false
},
"fingerprint": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"application": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"company": {
"type": "string"
},
"role": {
"type": "string"
}
},
"required": [
"id",
"company",
"role"
],
"additionalProperties": false
},
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"givenName": {
"type": "string",
"maxLength": 200
},
"familyName": {
"type": "string",
"maxLength": 200
},
"email": {
"type": "string",
"maxLength": 320
},
"phone": {
"type": "string",
"maxLength": 200
}
},
"required": [
"givenName",
"familyName",
"email",
"phone"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"profileRevision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"profileReviewedAt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"experience": {
"type": "string",
"maxLength": 30000
},
"letterText": {
"type": "string",
"maxLength": 130000
},
"answers": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"revision": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"question": {
"type": "string",
"maxLength": 2000
},
"answer": {
"type": "string",
"maxLength": 6000
},
"source": {
"enum": [
"manual",
"application",
"ai-assisted"
],
"type": "string"
},
"scope": {
"enum": [
"application",
"employer",
"reusable"
],
"type": "string"
},
"reviewedAt": {
"type": "string",
"format": "date-time"
}
},
"required": [
"id",
"revision",
"question",
"answer",
"source",
"scope",
"reviewedAt"
],
"additionalProperties": false
}
},
"documents": {
"type": "array",
"maxItems": 2,
"items": {
"type": "object",
"properties": {
"kind": {
"enum": [
"resume",
"letter"
],
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"revision": {
"type": "string"
}
},
"required": [
"kind",
"id",
"name",
"revision"
],
"additionalProperties": false
}
}
},
"required": [
"selection",
"fingerprint",
"application",
"contact",
"profileRevision",
"profileReviewedAt",
"experience",
"letterText",
"answers",
"documents"
],
"additionalProperties": false
},
"documents": {
"type": "array",
"maxItems": 2,
"items": {
"type": "object",
"properties": {
"kind": {
"enum": [
"resume",
"letter"
],
"type": "string"
},
"id": {
"type": "string"
},
"versionId": {
"type": "string"
},
"name": {
"type": "string"
},
"filename": {
"type": "string",
"maxLength": 200
},
"sha256": {
"type": "string",
"pattern": "^[a-f0-9]{64}$"
},
"base64": {
"type": "string",
"maxLength": 3000000,
"pattern": "^[A-Za-z0-9+/]*={0,2}$"
}
},
"required": [
"kind",
"id",
"versionId",
"name",
"filename",
"sha256",
"base64"
],
"additionalProperties": false
}
}
},
"required": [
"format",
"version",
"approvedAt",
"review",
"documents"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/packets\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"selection\": {\n \"applicationId\": \"<string>\",\n \"targetUrl\": \"<string>\",\n \"includeContact\": true,\n \"answerIds\": [\n \"<string>\"\n ]\n },\n \"fingerprint\": \"<string>\",\n \"reviewed\": true\n}'"
}
]
}
},
"/applications/lanes": {
"get": {
"operationId": "getApplicationLanes",
"summary": "Get application lanes",
"tags": [
"Applications"
],
"parameters": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lanes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"category": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"systemKey": {
"anyOf": [
{
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"retiredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"category",
"label",
"color",
"position",
"systemKey",
"closedReason",
"retiredAt"
]
}
}
},
"required": [
"revision",
"lanes"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/applications/lanes\" --header \"x-api-key: <api-key>\""
}
]
},
"post": {
"operationId": "createApplicationLane",
"summary": "Create application lane",
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"category": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"expectedRevision",
"label",
"category",
"color"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lanes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"category": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"systemKey": {
"anyOf": [
{
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"retiredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"category",
"label",
"color",
"position",
"systemKey",
"closedReason",
"retiredAt"
]
}
}
},
"required": [
"revision",
"lanes"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/lanes\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"expectedRevision\": 123,\n \"label\": \"<string>\",\n \"category\": \"saved\",\n \"color\": \"<string>\"\n}'"
}
]
}
},
"/applications/lanes/{id}": {
"put": {
"operationId": "updateApplicationLane",
"summary": "Rename or recolor application lane",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"label": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
}
},
"required": [
"expectedRevision"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lanes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"category": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"systemKey": {
"anyOf": [
{
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"retiredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"category",
"label",
"color",
"position",
"systemKey",
"closedReason",
"retiredAt"
]
}
}
},
"required": [
"revision",
"lanes"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PUT \"https://rxresu.me/api/openapi/applications/lanes/<id>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"expectedRevision\": 123\n}'"
}
]
}
},
"/applications/lanes/reorder": {
"post": {
"operationId": "reorderApplicationLanes",
"summary": "Reorder application lanes",
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"ids": {
"type": "array",
"minItems": 6,
"maxItems": 40,
"items": {
"type": "string"
}
}
},
"required": [
"expectedRevision",
"ids"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lanes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"category": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"systemKey": {
"anyOf": [
{
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"retiredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"category",
"label",
"color",
"position",
"systemKey",
"closedReason",
"retiredAt"
]
}
}
},
"required": [
"revision",
"lanes"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/lanes/reorder\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"expectedRevision\": 123,\n \"ids\": [\n \"<string>\"\n ]\n}'"
}
]
}
},
"/applications/lanes/{id}/retire": {
"post": {
"operationId": "retireApplicationLane",
"summary": "Retire application lane and move its applications",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expectedRevision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"replacementId": {
"type": "string"
}
},
"required": [
"expectedRevision",
"replacementId"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"lanes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"category": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 80
},
{
"type": "null"
}
]
},
"color": {
"type": "string",
"pattern": "^#[0-9a-fA-F]{6}$"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"systemKey": {
"anyOf": [
{
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"retiredAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"category",
"label",
"color",
"position",
"systemKey",
"closedReason",
"retiredAt"
]
}
}
},
"required": [
"revision",
"lanes"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/lanes/<id>/retire\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"expectedRevision\": 123,\n \"replacementId\": \"<string>\"\n}'"
}
]
}
},
"/applications/by-posting": {
"get": {
"operationId": "findTrackedPosting",
"summary": "Find an owned application by canonical posting URL",
"tags": [
"Applications"
],
"parameters": [
{
"name": "sourceUrl",
"in": "query",
"required": true,
"schema": {
"type": "string",
"maxLength": 2048
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"application": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"role": {
"type": "string"
},
"company": {
"type": "string"
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"role",
"company",
"sourceUrl"
]
},
{
"type": "null"
}
]
}
},
"required": [
"application"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/applications/by-posting?sourceUrl=<sourceUrl>\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/applications/prior-no-response": {
"get": {
"operationId": "getPriorNoResponseApplications",
"summary": "Find prior no-response applications at a company",
"description": "Up to the ten most recent earlier applications at the same company that ended without a response. With `anyOutcome`, up to the ten most recent earlier closed applications, with their outcome (`closedReason`). Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "company",
"in": "query",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "excludeId",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "anyOutcome",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"company": {
"type": "string"
},
"role": {
"type": "string"
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"company",
"role",
"at"
]
}
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/applications/prior-no-response?company=<company>\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/applications": {
"get": {
"operationId": "listApplications",
"summary": "List job applications",
"description": "Returns all job applications belonging to the authenticated user, most recently updated first. Optionally filter by pipeline stage. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results (1–100). Omit both pagination fields for the legacy complete list."
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Zero-based offset. Defaults to 0; limit defaults to 20 when only offset is given."
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "status",
"in": "query",
"schema": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "laneId",
"in": "query",
"schema": {
"type": "string",
"minLength": 1
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "tags",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true,
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "A list of the user's job applications.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"headers": {
"X-Total-Count": {
"description": "Total matching results before pagination.",
"schema": {
"type": "integer"
}
},
"X-Limit": {
"description": "Page size, when pagination is requested.",
"schema": {
"type": "integer"
}
},
"X-Offset": {
"description": "Zero-based offset, when pagination is requested.",
"schema": {
"type": "integer"
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/applications\" --header \"x-api-key: <api-key>\""
}
]
},
"post": {
"operationId": "createApplication",
"summary": "Create a job application",
"description": "Creates a new job application in the pipeline. Company and role are required; all other fields (stage, location, salary, source, linked resume, follow-up, notes, contacts) are optional. Requires authentication.",
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string",
"minLength": 1
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"stageEnteredAt": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"newId": {
"type": "string",
"format": "uuid",
"description": "A UUID the client chose for the new application. A retry of the same request with the same ID (after a lost response, say) returns the application already saved instead of saving another. The ID with any other request, one already used by a resume or application, or one whose application has since been deleted is refused with CONFLICT and nothing changes."
}
},
"required": [
"company",
"role"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string",
"minLength": 1
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"stageEnteredAt": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"resumeFile": {
"type": "string",
"contentMediaType": "application/pdf"
},
"coverLetterFile": {
"type": "string",
"contentMediaType": "application/pdf"
},
"newId": {
"type": "string",
"format": "uuid",
"description": "A UUID the client chose for the new application. A retry of the same request with the same ID (after a lost response, say) returns the application already saved instead of saving another. The ID with any other request, one already used by a resume or application, or one whose application has since been deleted is refused with CONFLICT and nothing changes."
}
},
"required": [
"company",
"role"
]
}
}
}
},
"responses": {
"200": {
"description": "The ID of the newly created application.",
"content": {
"application/json": {
"schema": {
"type": "string",
"description": "The ID of the created application."
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"company\": \"<string>\",\n \"role\": \"<string>\"\n}'"
}
]
},
"patch": {
"operationId": "patchApplications",
"summary": "Bulk update applications",
"description": "Applies the same change (move stage, archive/unarchive, add tags) to multiple applications at once. A closedReason requires every selected application to be Closed already, or status/laneId to move them to Closed. Contradictory selections fail atomically. Requires authentication.",
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"items": {
"type": "string"
}
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string",
"minLength": 1
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"addTags": {
"type": "array",
"items": {
"type": "string"
}
},
"expectedStages": {
"type": "array",
"maxItems": 200,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"stageEntryId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The ID of its latest stage change in `activity` then, so a move away and back counts too."
}
},
"required": [
"id",
"status",
"closedReason"
]
},
"description": "The stage each application had when the move was chosen. An application whose stage has changed since is left as it is, so a later move wins over a deferred one."
}
},
"required": [
"ids"
]
}
}
}
},
"responses": {
"200": {
"description": "The number of applications updated.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"updated": {
"type": "number"
},
"stages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"stageEntryId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"laneId",
"closedReason",
"stageEntryId"
]
},
"description": "Each counted application's stage as saved, with the ID of its latest stage change: what a later move of it expects."
}
},
"required": [
"updated",
"stages"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PATCH \"https://rxresu.me/api/openapi/applications\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"ids\": [\n \"<string>\"\n ]\n}'"
}
]
},
"delete": {
"operationId": "deleteApplications",
"summary": "Bulk delete applications",
"description": "Moves multiple applications to Trash, retaining their timelines, relationships and files. Requires authentication.",
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"items": {
"type": "string"
}
}
},
"required": [
"ids"
]
}
}
}
},
"responses": {
"200": {
"description": "The number of applications deleted.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted": {
"type": "number"
}
},
"required": [
"deleted"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/applications\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"ids\": [\n \"<string>\"\n ]\n}'"
}
]
}
},
"/applications/summary": {
"get": {
"operationId": "listApplicationSummaries",
"summary": "List application summaries",
"description": "Returns lightweight application summaries for list views. Full descriptions, notes, documents and timeline note text are omitted; structured followed-up events keep their contact timestamp and stage identity. Use the application endpoint for full detail. When includeInitialDetails is N, up to 2N full details may be attached as initialDetail: the union of the first N candidates under web and mobile ordering, with closed applications excluded unless status is provided.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results (1–100). Omit both pagination fields for the legacy complete list."
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Zero-based offset. Defaults to 0; limit defaults to 20 when only offset is given."
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "status",
"in": "query",
"schema": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "laneId",
"in": "query",
"schema": {
"type": "string",
"minLength": 1
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "tags",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"style": "deepObject",
"explode": true,
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "includeInitialDetails",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 6
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "A list of lightweight application summaries.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"initialDetail": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"resumeFileUrl",
"coverLetterUrl",
"source",
"tags",
"sourceUrl",
"matchScore",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"headers": {
"X-Total-Count": {
"description": "Total matching results before pagination.",
"schema": {
"type": "integer"
}
},
"X-Limit": {
"description": "Page size, when pagination is requested.",
"schema": {
"type": "integer"
}
},
"X-Offset": {
"description": "Zero-based offset, when pagination is requested.",
"schema": {
"type": "integer"
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/applications/summary\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/applications/{id}": {
"get": {
"operationId": "getApplication",
"summary": "Get application by ID",
"description": "Returns a single job application with its full detail (contacts, activity timeline, linked resume). Only applications belonging to the authenticated user can be retrieved. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The ID of the application."
}
}
],
"responses": {
"200": {
"description": "The job application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/applications/<id>\" --header \"x-api-key: <api-key>\""
}
]
},
"put": {
"operationId": "updateApplication",
"summary": "Update a job application",
"description": "Updates one or more fields of an application, including moving it to a different pipeline stage or archiving it. Moving stages automatically appends an entry to the activity timeline. Only provided fields are changed. Requires authentication.",
"deprecated": true,
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string",
"minLength": 1
},
"stageEnteredAt": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why the application closed; kept when status stays closed, cleared by any other stage."
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"resumeFile": {
"type": "string",
"contentMediaType": "application/pdf"
},
"coverLetterFile": {
"type": "string",
"contentMediaType": "application/pdf"
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string",
"minLength": 1
},
"stageEnteredAt": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why the application closed; kept when status stays closed, cleared by any other stage."
}
}
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PUT \"https://rxresu.me/api/openapi/applications/<id>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{}'"
}
]
},
"delete": {
"operationId": "deleteApplication",
"summary": "Delete a job application",
"description": "Moves a job application to Trash, retaining its timeline, relationships and files. Restore from Trash after reload. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "The ID of the application."
}
}
],
"responses": {
"200": {
"description": "The application was deleted successfully."
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/applications/<id>\" --header \"x-api-key: <api-key>\""
}
]
},
"patch": {
"operationId": "patchApplication",
"summary": "Update a job application",
"description": "Updates one or more fields of an application, including moving it to a different pipeline stage or archiving it. Moving stages automatically appends an entry to the activity timeline. Only provided fields are changed. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string",
"minLength": 1
},
"stageEnteredAt": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why the application closed; kept when status stays closed, cleared by any other stage."
}
}
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"resumeFile": {
"type": "string",
"contentMediaType": "application/pdf"
},
"coverLetterFile": {
"type": "string",
"contentMediaType": "application/pdf"
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string",
"minLength": 1
},
"stageEnteredAt": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why the application closed; kept when status stays closed, cleared by any other stage."
}
}
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PATCH \"https://rxresu.me/api/openapi/applications/<id>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{}'"
}
]
}
},
"/applications/import": {
"post": {
"operationId": "importApplications",
"summary": "Bulk import applications",
"description": "Creates many applications at once from a parsed CSV. Each item requires company and role. Returns the number imported. Requires authentication.",
"deprecated": true,
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"minItems": 1,
"maxItems": 500,
"items": {
"type": "object",
"properties": {
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string",
"minLength": 1
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"stageEnteredAt": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"applicationDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"company",
"role"
]
}
}
},
"required": [
"items"
]
}
}
}
},
"responses": {
"200": {
"description": "The number of applications imported.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"imported": {
"type": "number"
}
},
"required": [
"imported"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/import\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"items\": [\n {\n \"company\": \"<string>\",\n \"role\": \"<string>\"\n }\n ]\n}'"
}
]
}
},
"/applications/{id}/contacts/{index}": {
"delete": {
"operationId": "deleteApplicationContact",
"summary": "Remove an application contact",
"description": "Read the full application and retain its contactsVersion as expectedVersion. Removes only the contact at the reviewed index. On CONFLICT (409), reload and review again; never retry automatically with a new version. Requires authentication and delete permission.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "index",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expectedVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "The contactsVersion of the contacts array reviewed before removal."
}
},
"required": [
"expectedVersion"
]
}
}
}
},
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/applications/<id>/contacts/<index>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"expectedVersion\": \"<string>\"\n}'"
}
]
}
},
"/applications/{id}/documents/{kind}": {
"post": {
"operationId": "attachApplicationDocument",
"summary": "Attach an application document",
"description": "Uploads and attaches a PDF document to an application. Kind must be either resume or cover-letter. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "kind",
"in": "path",
"required": true,
"schema": {
"enum": [
"resume",
"cover-letter"
],
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"contentMediaType": "application/pdf"
}
},
"required": [
"file"
]
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/<id>/documents/<kind>\" --header \"x-api-key: <api-key>\" --form \"file=@<file>\""
}
]
},
"delete": {
"operationId": "removeApplicationDocument",
"summary": "Remove an application document",
"description": "Removes a resume or cover-letter PDF from an application and clears the stored document fields. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "kind",
"in": "path",
"required": true,
"schema": {
"enum": [
"resume",
"cover-letter"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/applications/<id>/documents/<kind>\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/applications/{id}/notes": {
"post": {
"operationId": "addApplicationNote",
"summary": "Log a note on the timeline",
"description": "Appends a free-text note to the application's activity timeline. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string",
"minLength": 1
},
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"text"
]
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/<id>/notes\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"text\": \"<string>\"\n}'"
}
]
}
},
"/applications/{id}/follow-ups": {
"post": {
"operationId": "logApplicationFollowUp",
"summary": "Log a completed follow-up",
"description": "Records contact now and restarts the no-reply clock for the current stage visit. Keeps stage dates and scheduled reminders. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/<id>/follow-ups\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/applications/{id}/replies": {
"post": {
"operationId": "logApplicationReply",
"summary": "Log an explicitly confirmed reply",
"description": "First GET /applications/{id}, review the full application and retain its opaque replyVersion. POST that value as expectedVersion. On CONFLICT (409), reload and review again before retrying. Records the user's confirmation of replying now, restarts the current stage's no-reply clock and clears the application's follow-up and its delivery schedule only at the reviewed revision. Sends no message. Keeps stage dates and interview reminders. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expectedVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "The replyVersion from the full application you reviewed; reload and review again on CONFLICT."
}
},
"required": [
"expectedVersion"
]
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/<id>/replies\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"expectedVersion\": \"<string>\"\n}'"
}
]
}
},
"/applications/{id}/interviews": {
"post": {
"operationId": "addApplicationInterview",
"summary": "Schedule an interview",
"description": "Adds an interview (screening, technical, behavioral, onsite or other) with a scheduled date-time to the application's activity timeline. Applications can have any number of interviews. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
},
"at": {
"type": "string",
"format": "date-time",
"description": "Scheduled start, as an ISO 8601 date-time."
}
},
"required": [
"kind",
"at"
]
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/<id>/interviews\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"kind\": \"screening\",\n \"at\": \"<string>\"\n}'"
}
]
}
},
"/applications/{id}/interviews/{entryId}": {
"put": {
"operationId": "updateApplicationInterview",
"summary": "Update a scheduled interview",
"description": "Updates an interview timeline entry (date-time, kind, duration, location, notes). Only provided fields are changed. Delete interviews with the timeline entry delete endpoint. Requires authentication.",
"deprecated": true,
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"at": {
"type": "string",
"format": "date-time",
"description": "Scheduled start, as an ISO 8601 date-time."
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440
},
"location": {
"type": "string",
"maxLength": 500
},
"notes": {
"type": "string",
"maxLength": 5000
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
}
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PUT \"https://rxresu.me/api/openapi/applications/<id>/interviews/<entryId>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{}'"
}
]
},
"patch": {
"operationId": "patchApplicationInterview",
"summary": "Update a scheduled interview",
"description": "Updates an interview timeline entry (date-time, kind, duration, location, notes). Only provided fields are changed. Delete interviews with the timeline entry delete endpoint. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"at": {
"type": "string",
"format": "date-time",
"description": "Scheduled start, as an ISO 8601 date-time."
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440
},
"location": {
"type": "string",
"maxLength": 500
},
"notes": {
"type": "string",
"maxLength": 5000
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
}
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PATCH \"https://rxresu.me/api/openapi/applications/<id>/interviews/<entryId>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{}'"
}
]
}
},
"/applications/{id}/timeline/{entryId}": {
"put": {
"operationId": "updateApplicationTimelineEntry",
"summary": "Update a timeline entry",
"description": "Updates a stage or note timeline entry date, or note text for note entries. Interview entries are rejected; use updateApplicationInterview. Requires authentication.",
"deprecated": true,
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"text": {
"type": "string",
"minLength": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PUT \"https://rxresu.me/api/openapi/applications/<id>/timeline/<entryId>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{}'"
}
]
},
"delete": {
"operationId": "deleteApplicationTimelineEntry",
"summary": "Delete a timeline entry",
"description": "Deletes a note or older stage entry. The current stage entry cannot be deleted. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request DELETE \"https://rxresu.me/api/openapi/applications/<id>/timeline/<entryId>\" --header \"x-api-key: <api-key>\""
}
]
},
"patch": {
"operationId": "patchApplicationTimelineEntry",
"summary": "Update a timeline entry",
"description": "Updates a stage or note timeline entry date, or note text for note entries. Interview entries are rejected; use updateApplicationInterview. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "entryId",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
},
"text": {
"type": "string",
"minLength": 1
}
}
}
}
}
},
"responses": {
"200": {
"description": "The updated application.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the application."
},
"company": {
"type": "string",
"minLength": 1,
"description": "The company applied to."
},
"role": {
"type": "string",
"minLength": 1,
"description": "The role / job title."
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"salary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string",
"description": "The current pipeline stage. `closed` ends it, with a reason."
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The owner-defined pipeline lane, when supported."
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
],
"description": "Why a closed application ended: accepted, not-selected, withdrew, accepted-other or no-response."
},
"resumeId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked Reactive Resume, if any."
},
"coverLetterId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The linked saved cover letter, if any."
},
"sentResumeVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked resume saved when the application was sent (reached Applied)."
},
"sentCheckScore": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
],
"description": "The resume's Check score when it was sent, out of 100."
},
"sentCoverLetterVersionId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The version of the linked letter saved when the application was sent."
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"sourceUrl": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null"
}
]
},
"jobDescription": {
"anyOf": [
{
"type": "string",
"maxLength": 20000
},
{
"type": "null"
}
]
},
"postingSource": {
"anyOf": [
{
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
{
"type": "null"
}
]
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, as read when the application was added."
},
"matchScore": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 100
},
{
"type": "null"
}
]
},
"aiMetadata": {
"anyOf": [
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
{
"type": "null"
}
]
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"resumeFileName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"coverLetterName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"followUpAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"followUpDateOnly": {
"type": "boolean",
"description": "True for a legacy date-only follow-up. False preserves an exact reminder instant, including UTC midnight."
},
"followUpNote": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"contacts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"default": ""
},
"type": {
"type": "string",
"default": ""
},
"email": {
"type": "string",
"default": ""
},
"phone": {
"type": "string",
"default": ""
}
},
"required": [
"name"
]
}
},
"activity": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "stage"
},
"stage": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string"
},
"laneLabel": {
"anyOf": [
{
"type": "string",
"maxLength": 80
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"canonicalTransition": {
"type": "boolean"
},
"dateUnknown": {
"type": "boolean"
},
"writeSequence": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"required": [
"id",
"at",
"type",
"stage"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "note"
},
"text": {
"type": "string",
"minLength": 1
},
"followedUp": {
"type": "object",
"properties": {
"stageEntryId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"kind": {
"const": "reply"
}
},
"required": [
"stageEntryId"
]
}
},
"required": [
"id",
"at",
"type",
"text"
]
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"at": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"type": {
"const": "interview"
},
"kind": {
"enum": [
"screening",
"technical",
"behavioral",
"onsite",
"other"
],
"type": "string"
},
"durationMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440,
"default": 60
},
"location": {
"type": "string",
"maxLength": 500,
"default": ""
},
"notes": {
"type": "string",
"maxLength": 5000,
"default": ""
},
"participants": {
"type": "array",
"maxItems": 20,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"role": {
"type": "string",
"maxLength": 200,
"default": ""
},
"profileUrl": {
"type": "string",
"maxLength": 2048,
"format": "uri"
}
},
"required": [
"name"
]
},
"default": []
},
"audience": {
"enum": [
"recruiter",
"hiring-manager",
"practitioner",
"panel",
"other"
],
"type": "string",
"default": "other"
},
"timezone": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"default": "UTC"
}
},
"required": [
"id",
"at",
"type",
"kind"
]
}
]
}
},
"trashedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
{
"type": "null"
}
]
},
"appliedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"createdAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"x-native-type": "date"
},
"replyVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque snapshot for logReply. Read the full application, review it, then send this value as expectedVersion. On CONFLICT, reload and review again."
},
"contactsVersion": {
"type": "string",
"minLength": 64,
"maxLength": 64,
"description": "Opaque contacts snapshot for deleteContact. Unrelated application edits do not change it."
}
},
"required": [
"id",
"company",
"role",
"location",
"salary",
"status",
"closedReason",
"resumeId",
"coverLetterId",
"sentResumeVersionId",
"sentCheckScore",
"sentCoverLetterVersionId",
"source",
"tags",
"sourceUrl",
"jobDescription",
"postingSource",
"requirements",
"matchScore",
"aiMetadata",
"notes",
"resumeFileUrl",
"resumeFileName",
"coverLetterUrl",
"coverLetterName",
"followUpAt",
"followUpNote",
"contacts",
"activity",
"appliedAt",
"createdAt",
"updatedAt"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request PATCH \"https://rxresu.me/api/openapi/applications/<id>/timeline/<entryId>\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{}'"
}
]
}
},
"/applications/bulk-update": {
"post": {
"operationId": "bulkUpdateApplications",
"summary": "Bulk update applications",
"description": "Applies the same change (move stage, archive/unarchive, add tags) to multiple applications at once. A closedReason requires every selected application to be Closed already, or status/laneId to move them to Closed. Contradictory selections fail atomically. Requires authentication.",
"deprecated": true,
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"items": {
"type": "string"
}
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"type": "string",
"minLength": 1
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"addTags": {
"type": "array",
"items": {
"type": "string"
}
},
"expectedStages": {
"type": "array",
"maxItems": 200,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"stageEntryId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The ID of its latest stage change in `activity` then, so a move away and back counts too."
}
},
"required": [
"id",
"status",
"closedReason"
]
},
"description": "The stage each application had when the move was chosen. An application whose stage has changed since is left as it is, so a later move wins over a deferred one."
}
},
"required": [
"ids"
]
}
}
}
},
"responses": {
"200": {
"description": "The number of applications updated.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"updated": {
"type": "number"
},
"stages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"laneId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"closedReason": {
"anyOf": [
{
"enum": [
"accepted",
"not-selected",
"withdrew",
"accepted-other",
"no-response"
],
"type": "string"
},
{
"type": "null"
}
]
},
"stageEntryId": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"status",
"laneId",
"closedReason",
"stageEntryId"
]
},
"description": "Each counted application's stage as saved, with the ID of its latest stage change: what a later move of it expects."
}
},
"required": [
"updated",
"stages"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/bulk-update\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"ids\": [\n \"<string>\"\n ]\n}'"
}
]
}
},
"/applications/bulk-delete": {
"post": {
"operationId": "bulkDeleteApplications",
"summary": "Bulk delete applications",
"description": "Moves multiple applications to Trash, retaining their timelines, relationships and files. Requires authentication.",
"deprecated": true,
"tags": [
"Applications"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ids": {
"type": "array",
"minItems": 1,
"maxItems": 200,
"items": {
"type": "string"
}
}
},
"required": [
"ids"
]
}
}
}
},
"responses": {
"200": {
"description": "The number of applications deleted.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deleted": {
"type": "number"
}
},
"required": [
"deleted"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/bulk-delete\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"ids\": [\n \"<string>\"\n ]\n}'"
}
]
}
},
"/applications/stats": {
"get": {
"operationId": "getApplicationStats",
"summary": "Application pipeline stats",
"description": "Returns aggregate counts (per stage, per source) for the Insights view. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [],
"responses": {
"200": {
"description": "Aggregate application counts.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"total": {
"type": "number"
},
"byStage": {
"type": "array",
"items": {
"type": "object",
"properties": {
"status": {
"enum": [
"saved",
"applied",
"screening",
"interview",
"offer",
"closed"
],
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"status",
"count"
]
}
},
"bySource": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"count": {
"type": "number"
}
},
"required": [
"source",
"count"
]
}
}
},
"required": [
"total",
"byStage",
"bySource"
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/applications/stats\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/applications/tags": {
"get": {
"operationId": "listApplicationTags",
"summary": "List application tags",
"description": "Returns the distinct tags used across the user's applications. Requires authentication.",
"tags": [
"Applications"
],
"parameters": [
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results (1–100). Omit both pagination fields for the legacy complete list."
},
"allowEmptyValue": true,
"allowReserved": true
},
{
"name": "offset",
"in": "query",
"schema": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "Zero-based offset. Defaults to 0; limit defaults to 20 when only offset is given."
},
"allowEmptyValue": true,
"allowReserved": true
}
],
"responses": {
"200": {
"description": "Distinct tags.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"headers": {
"X-Total-Count": {
"description": "Total matching results before pagination.",
"schema": {
"type": "integer"
}
},
"X-Limit": {
"description": "Page size, when pagination is requested.",
"schema": {
"type": "integer"
}
},
"X-Offset": {
"description": "Zero-based offset, when pagination is requested.",
"schema": {
"type": "integer"
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl \"https://rxresu.me/api/openapi/applications/tags\" --header \"x-api-key: <api-key>\""
}
]
}
},
"/applications/ai/search-postings": {
"post": {
"operationId": "searchApplicationPostings",
"summary": "Search job postings",
"description": "Searches through the server's SearXNG when it has one, otherwise the selected Firecrawl, Tavily or Exa connection. Returns up to five public links to review and import. Requires authentication.",
"deprecated": true,
"tags": [
"Applications",
"AI"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"query": {
"type": "string",
"minLength": 2,
"maxLength": 500
},
"aiProviderId": {
"type": "string",
"minLength": 1
}
},
"required": [
"query"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"title": {
"type": "string",
"maxLength": 1000
},
"description": {
"type": "string",
"maxLength": 5000,
"default": ""
}
},
"required": [
"url",
"title"
]
}
}
}
}
},
"429": {
"description": "429",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "RATE_LIMIT_EXCEEDED"
},
"status": {
"const": 429
},
"message": {
"type": "string",
"default": "Too many web requests. Try again later."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"502": {
"description": "502",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "SEARCH_AUTH"
},
"status": {
"const": 502
},
"message": {
"type": "string",
"default": "The web service rejected its key. Fix web access or paste a posting."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "SEARCH_QUOTA"
},
"status": {
"const": 502
},
"message": {
"type": "string",
"default": "The web service quota is used up. Fix web access or paste a posting."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "SEARCH_FAILED"
},
"status": {
"const": 502
},
"message": {
"type": "string",
"default": "Job search couldn't be reached. Try again or paste a posting link."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"503": {
"description": "503",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "SEARCH_UNAVAILABLE"
},
"status": {
"const": 503
},
"message": {
"type": "string",
"default": "Job search isn't configured on this server."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"defined",
"code",
"status",
"message"
],
"properties": {
"defined": {
"type": "boolean"
},
"code": {
"type": "string"
},
"status": {
"type": "integer"
},
"message": {
"type": "string"
},
"data": {}
}
}
}
}
}
},
"security": [
{
"apiKey": []
},
{
"bearerAuth": []
},
{
"cookieAuth": []
}
],
"x-codeSamples": [
{
"lang": "bash",
"label": "cURL",
"source": "curl --request POST \"https://rxresu.me/api/openapi/applications/ai/search-postings\" --header \"x-api-key: <api-key>\" --header \"Content-Type: application/json\" --data '{\n \"query\": \"<string>\"\n}'"
}
]
}
},
"/applications/ai/parse-posting": {
"post": {
"operationId": "aiParseApplicationPosting",
"summary": "Read a job posting",
"description": "Reads a job link or pasted posting text into role, company, location, salary and requirements, and returns the posting text to save with the application. Links must be public https pages. Set useAI:false to read without AI, or true to allow AI enrichment. If omitted, AI is attempted only when the page lacks a role, company or description. Without an AI provider, only a page's own job data (JSON-LD) fills the fields. Requires authentication.",
"deprecated": true,
"tags": [
"Applications",
"AI"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"input": {
"type": "string",
"minLength": 1,
"maxLength": 100000
},
"useAI": {
"type": "boolean",
"description": "False never uses AI; true allows AI enrichment. Omit to use AI only when structured page data is incomplete."
}
},
"required": [
"input"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"role": {
"type": "string"
},
"company": {
"type": "string"
},
"location": {
"type": "string"
},
"salary": {
"type": "string"
},
"requirements": {
"type": "array",
"items": {
"type": "string"
},
"description": "What the posting asks for, one short item each."
},
"jobDescription": {
"type": "string",
"description": "The posting's text, to save with the application."
},
"sourceUrl": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "The link, when a link was given."
},
"postingSource": {
"type": "object",
"properties": {
"method": {
"enum": [
"paste",
"builtin",
"firecrawl",
"tavily",
"exa"
],
"type": "string"
},
"format": {
"enum": [
"text",
"markdown"
],
"type": "string"
},
"requestedUrl": {
"type": "string",
"format": "uri"
},
"resolvedUrl": {
"type": "string",
"format": "uri"
},
"retrievedAt": {
"type": "string",
"format": "date-time"
},
"providerFetchedAt": {
"type": "string",
"format": "date-time"
},
"truncated": {
"type": "boolean"
},
"completeness": {
"enum": [
"unknown",
"incomplete"
],
"type": "string"
},
"language": {
"type": "string",
"maxLength": 35
},
"fallbackReason": {
"enum": [
"unsafe-url",
"unreachable",
"not-a-page",
"too-large",
"auth",
"quota",
"malformed",
"empty",
"challenge",
"timeout",
"unavailable",
"rate-limit"
],
"type": "string"
}
},
"required": [
"method",
"format",
"truncated",
"completeness"
]
},
"enrichmentWarning": {
"anyOf": [
{
"enum": [
"ai-unavailable"
],
"type": "string"
},
{
"type": "null"
}
]
},
"filledBy": {
"enum": [
"ai",
"page",
"none"
],
"type": "string",
"description": "What filled the fields: the AI provider, the page's own job data, or nothing (fill them in)."
}
},
"required": [
"role",
"company",
"location",
"salary",
"requirements",
"jobDescription",
"sourceUrl",
"postingSource",
"enrichmentWarning",
"filledBy"
]
}
}
}
},
"400": {
"description": "400",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_REQUEST"
},
"status": {
"const": 400
},
"message": {
"type": "string",
"default": "The application or AI request isn't valid. Check the details and try again."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"422": {
"description": "422",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "POSTING_UNREADABLE"
},
"status": {
"const": 422
},
"message": {
"type": "string",
"default": "That link couldn't be read. Paste the posting text instead."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"429": {
"description": "429",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "RATE_LIMIT_EXCEEDED"
},
"status": {
"const": 429
},
"message": {
"type": "string",
"default": "Too many web requests. Try again later."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"502": {
"description": "502",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"properties": {
"defined": {
"const": true
},
"code": {
"const": "BAD_GATEWAY"
},
"status": {
"const": 502
},
"message": {
"type": "string",
"default": "The AI provider returned an error or couldn't be reached. Try again, or check its settings."
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
},
{
"type": "object",
"properties": {
"defined": {
"const": false
},
"code": {
"type": "string"
},
"status": {
"type": "number"
},
"message": {
"type": "string"
},
"data": {}
},
"required": [
"defined",
"code",
"status",
"message"
]
}
]
}
}
}
},
"default": {
"description": "Structured API error. See status and code; do not branch on message text.",
"content": {
"aFile truncated at 1 MB.