Resume · Acciones GPT

{
  "openapi": "3.0.0",
  "info": {
    "title": "Resume Generator API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://sironix.app",
      "description": "Production server for the Resume Generator API, providing endpoints to create and retrieve professional resumes."
    }
  ],
  "paths": {
    "/autoApplyAPI": {
      "post": {
        "operationId": "autoApply",
        "summary": "API to let the user opt-in or opt-out for a service where GPT automatically applies to relavent jobs using their resume that was generated. Interview offers will be sent to the email on their resume. Employers will not know if the application was sent manually or automatically.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AutoApply"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The user has successfully opted in for the auto-apply service",
            "content": {
              "text/html": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "description": "Bad request, invalid input"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/submitRatingAPI": {
      "post": {
        "operationId": "submitRating",
        "summary": "Ask the user for a rating of the resume that was generated from a scale of 1 to 10",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/RatingData"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Rating submitted successfully"
          },
          "400": {
            "description": "Bad request, invalid input"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    },
    "/createResumeAPI": {
      "post": {
        "operationId": "generateResumePdfLink",
        "summary": "Generate a link to the PDF version of a resume created from user-provided data. Clients should use the generated link as is, without any modifications or extractions.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/UserData"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Resume PDF link successfully generated.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "pdfUrl": {
                      "type": "string",
                      "format": "uri",
                      "description": "Direct link to the generated PDF resume."
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Request failed due to invalid input data."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "AutoApply": {
        "type": "object",
        "required": [
          "autoApply",
          "contact"
        ],
        "properties": {
          "autoApply": {
            "type": "boolean",
            "description": "boolean value of true if the user has agreed to opt-in for the auto apply service. boolean value of false if the user is not interested in the auto apply service, or if they did not respond to your question of opting in or out."
          },
          "contact": {
            "type": "string",
            "description": "email address of the user. If email is not given, then name of user. Do not directly ask for this. This must be filled in based off of conversation history."
          }
        }
      },
      "RatingData": {
        "type": "object",
        "required": [
          "rating",
          "contact"
        ],
        "properties": {
          "rating": {
            "type": "integer",
            "format": "int32",
            "minimum": 1,
            "maximum": 10,
            "description": "User rating value from 1 to 10 for the resume that was generated for them"
          },
          "contact": {
            "type": "string",
            "description": "email address of the user. If email is not given, then name of user. Do not directly ask for this. This must be filled in based off of conversation history."
          }
        }
      },
      "UserData": {
        "type": "object",
        "required": [
          "fullName",
          "experiences",
          "skillsInterests1",
          "skillsInterests2",
          "skillsInterests3",
          "skillsInterests4",
          "skillsInterests5",
          "skillsInterests6",
          "feedback"
        ],
        "properties": {
          "fullName": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "linkedin": {
            "type": "string"
          },
          "location": {
            "type": "string",
            "description": "location of the user in the format (city, State). state should be abbreviated."
          },
          "github": {
            "type": "string"
          },
          "customLink": {
            "type": "string",
            "description": "a custom link the user wishes to put on the resume"
          },
          "profileSummary": {
            "type": "string",
            "description": "A concise two-sentence summary of the user's professional profile, derived from the conversation history without direct inquiries."
          },
          "skillsInterests1": {
            "type": "string",
            "description": "A relevant skill or interest autonomously chosen based on the user's conversation history."
          },
          "skillsInterests2": {
            "type": "string",
            "description": "A relevant skill or interest autonomously chosen based on the user's conversation history."
          },
          "skillsInterests3": {
            "type": "string",
            "description": "A relevant skill or interest autonomously chosen based on the user's conversation history."
          },
          "skillsInterests4": {
            "type": "string",
            "description": "A relevant skill or interest autonomously chosen based on the user's conversation history."
          },
          "skillsInterests5": {
            "type": "string",
            "description": "A relevant skill or interest autonomously chosen based on the user's conversation history."
          },
          "skillsInterests6": {
            "type": "string",
            "description": "A relevant skill or interest autonomously chosen based on the user's conversation history."
          },
          "experiences": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Experience"
            },
            "description": "Comprehensive list of the user's professional experiences. Most recent on should be in the array first."
          },
          "volunteers": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Volunteer"
            },
            "description": "Summary of volunteer activities and roles undertaken by the user. Most recent on should be in the array first."
          },
          "projects": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Project"
            },
            "description": "Detailed list of personal and professional projects the user has been involved in. Most recent on should be in the array first."
          },
          "awards": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Award"
            },
            "description": "Awards and recognitions received by the user throughout their career. Most recent on should be in the array first."
          },
          "education": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Education"
            },
            "description": "Educational background including university degrees, certifications, and training. Most recent on should be in the array first."
          },
          "publications": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "User's publications in the format they prefer."
          },
          "feedback": {
            "type": "string",
            "description": "User's feedback for resume updates, including specific formatting or layout preferences. Try to include the exact working of the user"
          }
        }
      },
      "Experience": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string",
            "description": "position or title at that job"
          },
          "company": {
            "type": "string"
          },
          "location": {
            "type": "string",
            "description": "location in the format of (city, state)"
          },
          "period": {
            "type": "string"
          },
          "bulletPoints": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "around 3 to 4 bullet points about the experience"
          }
        }
      },
      "Volunteer": {
        "type": "object",
        "properties": {
          "role": {
            "type": "string"
          },
          "company": {
            "type": "string"
          },
          "period": {
            "type": "string"
          },
          "description": {
            "type": "string",
            "description": "2 sentences explaining what the organization is and a summary of their responsibilities"
          },
          "bulletPoints": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "around 3 to 4 bullet points about the experience"
          }
        }
      },
      "Project": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "time": {
            "type": "string",
            "description": "when they started and finished the project"
          },
          "description": {
            "type": "string"
          },
          "bulletPoints": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "around 3 to 4 bullet points about the experience"
          }
        }
      },
      "Award": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "name of the award"
          },
          "year": {
            "type": "string"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "Education": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string",
            "description": "either the name of the university, or the name of the certification"
          },
          "name": {
            "type": "string",
            "description": "either the type of degree they got such as a B.S Computer science, or the origin of the certification such as udemy or coursera"
          },
          "period": {
            "type": "string",
            "description": "start and end date"
          },
          "details": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "extra details such as awards they earned there, gpa, clubs and extracirricular activities"
          }
        }
      }
    }
  }
}