Skip to content

Response Models

Pydantic models for structured response data. These are provided for convenience and type safety — the client returns plain dict objects from the API, which you can optionally validate with these models.

Response models returned by the Resumly SDK.

BaseResume

Bases: BaseModel

Represents the parsed base resume returned by the API.

base_resume class-attribute instance-attribute 

base_resume: Optional[Dict[str, Any]] = None

base_resume_name class-attribute instance-attribute 

base_resume_name: Optional[str] = None

base_resume_last_updated class-attribute instance-attribute 

base_resume_last_updated: Optional[str] = None

ResumeListItem

Bases: BaseModel

job_id instance-attribute 

job_id: str

status class-attribute instance-attribute 

status: Optional[str] = None

date_created class-attribute instance-attribute 

date_created: Optional[str] = None

company class-attribute instance-attribute 

company: Optional[str] = None

job_title class-attribute instance-attribute 

job_title: Optional[str] = None

has_download class-attribute instance-attribute 

has_download: bool = False

ResumeListResponse

Bases: BaseModel

resumes instance-attribute 

resumes: List[ResumeListItem]

total instance-attribute 

total: int

page instance-attribute 

page: int

page_size instance-attribute 

page_size: int

CreatedResume

Bases: BaseModel

Returned after creating a tailored resume.

job_id instance-attribute 

job_id: str

status class-attribute instance-attribute 

status: Optional[str] = None

company class-attribute instance-attribute 

company: Optional[str] = None

job_title class-attribute instance-attribute 

job_title: Optional[str] = None

download_url class-attribute instance-attribute 

download_url: Optional[str] = None

ATSReport

Bases: BaseModel

ATS check analysis report.

analysis_id instance-attribute 

analysis_id: str

job_id instance-attribute 

job_id: str

report class-attribute instance-attribute 

report: Optional[Dict[str, Any]] = None

status class-attribute instance-attribute 

status: Optional[str] = None

ApiKeyInfo

Bases: BaseModel

Metadata about an API key (full key never returned after creation).

id instance-attribute 

id: str

key_prefix instance-attribute 

key_prefix: str

name instance-attribute 

name: str

created_at instance-attribute 

created_at: str

last_used_at class-attribute instance-attribute 

last_used_at: Optional[str] = None

is_active class-attribute instance-attribute 

is_active: bool = True

raw_key class-attribute instance-attribute 

raw_key: Optional[str] = None

InboxStatus

Bases: BaseModel

Inbox initialisation status.

initialized class-attribute instance-attribute 

initialized: bool = False

address class-attribute instance-attribute 

address: Optional[str] = None

user_email class-attribute instance-attribute 

user_email: Optional[str] = None

EmailMessage

Bases: BaseModel

A single inbox email.

id class-attribute instance-attribute 

id: str = Field(alias='_id')

subject class-attribute instance-attribute 

subject: Optional[str] = None

from_address class-attribute instance-attribute 

from_address: Optional[str] = Field(None, alias='from')

to class-attribute instance-attribute 

to: Optional[List[str]] = None

date class-attribute instance-attribute 

date: Optional[str] = None

body_text class-attribute instance-attribute 

body_text: Optional[str] = None

body_html class-attribute instance-attribute 

body_html: Optional[str] = None

is_read class-attribute instance-attribute 

is_read: bool = False

is_starred class-attribute instance-attribute 

is_starred: bool = False

is_archived class-attribute instance-attribute 

is_archived: bool = False

category class-attribute instance-attribute 

category: Optional[str] = None

Config

populate_by_name class-attribute instance-attribute 

populate_by_name = True

AutoApplyJob

Bases: BaseModel

A job eligible for auto-apply.

job_id instance-attribute 

job_id: str

title class-attribute instance-attribute 

title: Optional[str] = None

company class-attribute instance-attribute 

company: Optional[str] = None

location class-attribute instance-attribute 

location: Optional[str] = None

match_score class-attribute instance-attribute 

match_score: Optional[str] = None

queue_status class-attribute instance-attribute 

queue_status: Optional[str] = None

CoverLetter

Bases: BaseModel

Cover letter data.

job_id instance-attribute 

job_id: str

cover_letter class-attribute instance-attribute 

cover_letter: Optional[Dict[str, Any]] = None

cover_letter_text class-attribute instance-attribute 

cover_letter_text: Optional[str] = None

status class-attribute instance-attribute 

status: Optional[str] = None

InterviewQuestion

Bases: BaseModel

A single interview question.

question instance-attribute 

question: str

category class-attribute instance-attribute 

category: Optional[str] = None

difficulty class-attribute instance-attribute 

difficulty: Optional[str] = None

JobMatchScore

Bases: BaseModel

Job match scoring result.

score class-attribute instance-attribute 

score: Optional[float] = None

match_level class-attribute instance-attribute 

match_level: Optional[str] = None

details class-attribute instance-attribute 

details: Optional[Dict[str, Any]] = None

CalculatorSpec

Bases: BaseModel

Input specification for a career calculator tool.

tool_name instance-attribute 

tool_name: str

title class-attribute instance-attribute 

title: Optional[str] = None

description class-attribute instance-attribute 

description: Optional[str] = None

fields class-attribute instance-attribute 

fields: Optional[List[Dict[str, Any]]] = None

CalculatorResult

Bases: BaseModel

Evaluation result from a career calculator tool.

tool_name class-attribute instance-attribute 

tool_name: Optional[str] = None

score class-attribute instance-attribute 

score: Optional[float] = None

label class-attribute instance-attribute 

label: Optional[str] = None

details class-attribute instance-attribute 

details: Optional[Dict[str, Any]] = None