ResumeMaker AI

ResumeMaker AI · Ações GPT

FastAPI

  • GET /gpts/resume/get_template_imagesGet Template Images

    Used to get the images for available resume templates

  • GET /gpts/resume/get_cv_templatesGet Templates

    Used to get Available Resume Templates and schema of the json that can be used to fill them using make_cv.

  • POST /gpts/resume/make_cvMake Cv

    Used to create a cv. It takes in a template name and the json dict containing user data according to the template that follows proper schema. Ask user for missing values

Esquema API original
{
  "openapi": "3.1.0",
  "info": {
    "title": "FastAPI",
    "version": "0.1.0"
  },
  "paths": {
    "/gpts/resume/get_template_images": {
      "get": {
        "tags": [
          "gpts"
        ],
        "summary": "Get Template Images",
        "description": "Used to get the images for available resume templates",
        "operationId": "get_template_images_gpts_resume_get_template_images_get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        },
        "security": [
          {
            "HTTPBearer": []
          }
        ]
      }
    },
    "/gpts/resume/get_cv_templates": {
      "get": {
        "tags": [
          "gpts"
        ],
        "summary": "Get Templates",
        "description": "Used to get Available Resume Templates and schema of the json that can be used to fill them using make_cv.",
        "operationId": "get_templates_gpts_resume_get_cv_templates_get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        },
        "security": [
          {
            "HTTPBearer": []
          }
        ]
      }
    },
    "/gpts/resume/make_cv": {
      "post": {
        "tags": [
          "gpts"
        ],
        "summary": "Make Cv",
        "description": "Used to create a cv. It takes in a template name and the json dict containing user data according to the template that follows proper schema. Ask user for missing values",
        "operationId": "make_cv_gpts_resume_make_cv_post",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/MakeCV"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        },
        "security": [
          {
            "HTTPBearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "MakeCV": {
        "properties": {
          "resume_data": {
            "type": "string",
            "title": "Resume Data",
            "description": "The json object which follows the correct schema for the template provided by get_cv_templates. Ask user for missing values"
          },
          "template_name": {
            "type": "string",
            "title": "Template Name",
            "description": "The name of the template to use. Must be from ['templates']"
          },
          "output_format": {
            "allOf": [
              {
                "$ref": "#/components/schemas/OutputFormat"
              }
            ],
            "description": "The format to output the resume in, can be 'PDF' OR 'IMAGE'",
            "default": "PDF"
          }
        },
        "type": "object",
        "required": [
          "resume_data",
          "template_name"
        ],
        "title": "MakeCV"
      },
      "OutputFormat": {
        "type": "string",
        "enum": [
          "PDF",
          "IMAGE"
        ],
        "title": "OutputFormat"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      }
    },
    "securitySchemes": {
      "HTTPBearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.academiai.org"
    }
  ]
}