Resume / CV

Extract contact info, education, experience, and skills.

Schema Key

resume

Usage

Use this template when creating a schema via the API or SDK:

const schema = await client.schemas.create('my-workspace', {
  schemaKey: 'resume',
  name: 'Resume / CV',
  definition: { /* see definition below */ },
});

Definition

{
  "type": "object",
  "properties": {
    "profile": {
      "type": "object",
      "description": "Basic profile information of the candidate.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Full name of the candidate."
        },
        "title": {
          "type": "string",
          "description": "Current or most recent professional title of the candidate."
        },
        "email": {
          "type": "string",
          "description": "Email address.",
          "format": "email"
        },
        "phone": {
          "type": "string",
          "description": "Contact phone number."
        },
        "url": {
          "type": "string",
          "description": "A URL such as personal website or LinkedIn profile."
        },
        "summary": {
          "type": "string",
          "description": "Professional summary or overview."
        },
        "location": {
          "type": "object",
          "description": "Location information.",
          "properties": {
            "city": {
              "type": "string",
              "description": "City of residence."
            },
            "country": {
              "type": "string",
              "description": "Country of residence."
            }
          },
          "required": [
            "city",
            "country"
          ],
          "additionalProperties": false
        }
      },
      "required": [
        "name",
        "title",
        "email",
        "phone",
        "url",
        "summary",
        "location"
      ],
      "additionalProperties": false
    },
    "workExperiences": {
      "type": "array",
      "description": "List of work experiences.",
      "items": {
        "type": "object",
        "properties": {
          "company": {
            "type": "string",
            "description": "Name of the company."
          },
          "position": {
            "type": "string",
            "description": "Job position held."
          },
          "date_range": {
            "type": "object",
            "description": "Employment period with start and optional end date.",
            "properties": {
              "start": {
                "type": "object",
                "properties": {
                  "year": {
                    "type": "integer",
                    "description": "Year (e.g. 2020)."
                  },
                  "month": {
                    "type": "integer",
                    "description": "Month (1-12).",
                    "minimum": 1,
                    "maximum": 12
                  }
                },
                "required": [
                  "year",
                  "month"
                ],
                "additionalProperties": false
              },
              "end": {
                "type": "object",
                "properties": {
                  "year": {
                    "type": "integer",
                    "description": "Year (e.g. 2024)."
                  },
                  "month": {
                    "type": "integer",
                    "description": "Month (1-12).",
                    "minimum": 1,
                    "maximum": 12
                  }
                },
                "required": [
                  "year",
                  "month"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "start"
            ],
            "additionalProperties": false
          },
          "location": {
            "type": "object",
            "properties": {
              "city": {
                "type": "string",
                "description": "City where the position was held."
              },
              "country": {
                "type": "string",
                "description": "Country where the position was held."
              }
            },
            "required": [
              "city",
              "country"
            ],
            "additionalProperties": false
          },
          "description": {
            "type": "string",
            "description": "Description of responsibilities and achievements."
          }
        },
        "required": [
          "company",
          "position",
          "date_range",
          "description"
        ],
        "additionalProperties": false
      }
    },
    "educations": {
      "type": "array",
      "description": "List of education records.",
      "items": {
        "type": "object",
        "properties": {
          "school": {
            "type": "string",
            "description": "School or institution name."
          },
          "degree": {
            "type": "string",
            "description": "Degree or certification obtained."
          },
          "date_range": {
            "type": "object",
            "description": "Education period with start and optional end date.",
            "properties": {
              "start": {
                "type": "object",
                "properties": {
                  "year": {
                    "type": "integer"
                  },
                  "month": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 12
                  }
                },
                "required": [
                  "year",
                  "month"
                ],
                "additionalProperties": false
              },
              "end": {
                "type": "object",
                "properties": {
                  "year": {
                    "type": "integer"
                  },
                  "month": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 12
                  }
                },
                "required": [
                  "year",
                  "month"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "start"
            ],
            "additionalProperties": false
          },
          "location": {
            "type": "object",
            "properties": {
              "city": {
                "type": "string"
              },
              "country": {
                "type": "string"
              }
            },
            "required": [
              "city",
              "country"
            ],
            "additionalProperties": false
          },
          "gpa": {
            "type": "string",
            "description": "Grade point average as provided."
          },
          "description": {
            "type": "string",
            "description": "Short description or relevant notes."
          }
        },
        "required": [
          "school",
          "degree",
          "date_range",
          "gpa",
          "description"
        ],
        "additionalProperties": false
      }
    },
    "projects": {
      "type": "array",
      "description": "List of projects.",
      "items": {
        "type": "object",
        "properties": {
          "project": {
            "type": "string",
            "description": "Project title or name."
          },
          "date_range": {
            "type": "object",
            "properties": {
              "start": {
                "type": "object",
                "properties": {
                  "year": {
                    "type": "integer"
                  },
                  "month": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 12
                  }
                },
                "required": [
                  "year",
                  "month"
                ],
                "additionalProperties": false
              },
              "end": {
                "type": "object",
                "properties": {
                  "year": {
                    "type": "integer"
                  },
                  "month": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 12
                  }
                },
                "required": [
                  "year",
                  "month"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "start"
            ],
            "additionalProperties": false
          },
          "description": {
            "type": "string",
            "description": "Short description of the project."
          }
        },
        "required": [
          "project",
          "date_range",
          "description"
        ],
        "additionalProperties": false
      }
    },
    "skills": {
      "type": "array",
      "description": "List of unique, normalized skills.",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the skill."
          }
        },
        "required": [
          "name"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "profile",
    "workExperiences",
    "educations",
    "projects",
    "skills"
  ],
  "additionalProperties": false
}