Skip to content

API Reference

models

Modules:

  • base –
  • book –
  • change_log –
  • character –
  • item –
  • light_cone –
  • message –
  • relic –

Classes:

  • BaseSkill –

    Represent a base skill or a trace node in the character's skill tree.

  • Book –

    Represent basic information about a book.

  • BookDetail –

    Represent detailed information about a book.

  • BookSeries –

    Represent a book series.

  • Changelog –

    Represent a changelog entry for a specific version.

  • ChangelogCategory –

    Represent a category of changes within a changelog entry.

  • Character –

    Represent basic information about a character.

  • CharacterAscensionItem –

    Represent an item and amount required for character ascension.

  • CharacterCostItem –

    Represent an item and amount required for character level upgrades.

  • CharacterDetail –

    Represent detailed information about a character.

  • CharacterDetailType –

    Represent either the Path or Combat Type with its ID and name.

  • CharacterDetailTypes –

    Contain the character's Path and Combat Type details.

  • CharacterEidolon –

    Represent a character Eidolon.

  • CharacterInfo –

    Represent additional information about a character (fetter info).

  • CharacterScript –

    Contain character stories and voice lines.

  • CharacterStory –

    Represent a piece of character story/lore.

  • CharacterTraces –

    Contain all character traces (skills and passive abilities).

  • CharacterType –

    Contain the character's Path and Combat Type enums.

  • CharacterUpgrade –

    Represent the details for a specific character ascension rank.

  • CharacterVoice –

    Represent a character voice line.

  • Contact –

    Represent a message contact.

  • ExtraEffect –

    Represent an extra effect associated with a skill.

  • Item –

    Represent basic information about an item.

  • ItemDetail –

    Represent detailed information about an item.

  • ItemSource –

    Represent a source from which an item can be obtained.

  • ItemType –

    Represent the type of an item.

  • LightCone –

    Represent basic information about a light cone.

  • LightConeAscensionMaterial –

    Represent a material required for light cone ascension.

  • LightConeCostItem –

    Represent an item and its amount required for upgrading a light cone.

  • LightConeDetail –

    Represent detailed information about a light cone.

  • LightConePathType –

    Represent the path type of a light cone.

  • LightConeSkill –

    Represent the skill of a light cone.

  • LightConeUpgrade –

    Represent the details for a specific ascension level of a light cone.

  • Message –

    Represent a message thread or conversation.

  • Recipe –

    Represent a recipe to craft or obtain an item.

  • RecipeMaterial –

    Represent a material required for a recipe.

  • Relic –

    Represent a single relic piece.

  • RelicSet –

    Represent basic information about a relic set.

  • RelicSetDetail –

    Represent detailed information about a relic set.

  • SetEffect –

    Represent a set effect for a relic set.

  • SetEffects –

    Contain the 2-piece and 4-piece set effects.

  • SkillAdd –

    Represent a skill level increase granted by an Eidolon.

  • SkillListSkill –

    Represent detailed information about a specific character skill (Basic ATK, Skill, Ultimate, Talent).

  • SkillPoint –

    Represent skill point generation or consumption by a skill.

  • SkillPromote –

    Represent the cost to promote (level up) a skill/trace to a specific level.

  • SkillPromoteCostItem –

    Represent an item and amount required for promoting (leveling up) a skill/trace.

  • SkillTree –

    Represent a skill tree structure for a character.

  • SkillTreeSkill –

    Represent a connection or node within a skill tree structure.

  • Status –

    Represent a status effect or stat bonus granted by a trace node.

  • VoiceActor –

    Represent a voice actor for a specific language.

  • WeaknessBreak –

    Represent the toughness damage dealt by a skill.

BaseSkill pydantic-model

Represent a base skill or a trace node in the character's skill tree.

Attributes:

  • id (int) –

    The unique identifier for the skill or trace node.

  • name (str | None) –

    The name of the skill or trace node (optional for some traces).

  • description (str | None) –

    The description of the skill or trace node (optional for some traces).

  • point_type (str) –

    The type of point in the skill tree.

  • point_position (str) –

    The position identifier within the skill tree.

  • max_level (int) –

    The maximum level this skill or trace can reach.

  • is_default (bool) –

    Whether this skill/trace is unlocked by default.

  • avatar_level_limit (int | None) –

    The character level required to unlock this trace (optional).

  • avatar_promotion_limit (int | None) –

    The character ascension rank required to unlock this trace (optional).

  • skill_list (list[SkillListSkill]) –

    Detailed information if this node represents a main skill (Basic ATK, Skill, etc.).

  • status_list (list[Status]) –

    List of status effects or stat bonuses granted by this trace node.

  • icon (str) –

    The URL to the icon for this skill or trace node.

  • params (dict[str, list[float]] | None) –

    Parameters used for scaling (optional).

  • promote (list[SkillPromote]) –

    List of promotion costs for leveling up this skill or trace.

Fields:

Validators:

avatar_level_limit pydantic-field 

avatar_level_limit: int | None

avatar_promotion_limit pydantic-field 

avatar_promotion_limit: int | None

description pydantic-field 

description: str | None

icon pydantic-field 

icon: str

id pydantic-field 

id: int

is_default pydantic-field 

is_default: bool

max_level pydantic-field 

max_level: int

name pydantic-field 

name: str | None

params pydantic-field 

params: dict[str, list[float]] | None

point_position pydantic-field 

point_position: str

point_type pydantic-field 

point_type: str

promote pydantic-field 

promote: list[SkillPromote]

skill_list pydantic-field 

skill_list: list[SkillListSkill]

status_list pydantic-field 

status_list: list[Status]

Book pydantic-model

Represent basic information about a book.

Attributes:

  • id (int) –

    The ID of the book.

  • name (str) –

    The name of the book.

  • world_type (int) –

    The numeric ID representing the type of world the book is associated with.

  • chapter_count (int) –

    The number of chapters in the book.

  • icon (str) –

    The URL of the book's icon.

  • route (str) –

    The API route for this book.

Fields:

Validators:

  • __convert_icon → icon

chapter_count pydantic-field 

chapter_count: int

icon pydantic-field 

icon: str

id pydantic-field 

id: int

name pydantic-field 

name: str

route pydantic-field 

route: str

world_type pydantic-field 

world_type: int

BookDetail pydantic-model

Represent detailed information about a book.

Attributes:

Fields:

Validators:

  • __convert_icon → icon
  • __convert_series → series

chapter_count pydantic-field 

chapter_count: int = 0

description pydantic-field 

description: str

icon pydantic-field 

icon: str

id pydantic-field 

id: int

name pydantic-field 

name: str

series pydantic-field 

series: list[BookSeries]

world_type pydantic-field 

world_type: str

BookSeries pydantic-model

Represent a book series.

Attributes:

  • id (int) –

    The ID of the series.

  • name (str) –

    The name of the series.

  • story (str) –

    The story or description of the series.

  • image_list (list[str]) –

    A list of image URLs associated with the series.

Fields:

Validators:

id pydantic-field 

id: int

image_list pydantic-field 

image_list: list[str]

name pydantic-field 

name: str

story pydantic-field 

story: str

Changelog pydantic-model

Represent a changelog entry for a specific version.

Attributes:

  • id (int) –

    The unique identifier for the changelog entry.

  • version (str) –

    The version string associated with these changes.

  • categories (list[ChangelogCategory]) –

    A list of categories detailing the changes.

  • beta (bool) –

    Whether this changelog pertains to a beta version.

Fields:

Validators:

beta pydantic-field 

beta: bool = False

categories pydantic-field 

categories: list[ChangelogCategory]

id pydantic-field 

id: int

version pydantic-field 

version: str

ChangelogCategory pydantic-model

Represent a category of changes within a changelog entry.

Attributes:

  • category (str) –

    The name of the category (e.g., "avatar", "equipment").

  • item_ids (list[int]) –

    A list of item IDs that were changed within this category.

Fields:

Validators:

category pydantic-field 

category: str

item_ids pydantic-field 

item_ids: list[int]

Character pydantic-model

Represent basic information about a character.

Attributes:

  • id (int) –

    The unique identifier for the character.

  • name (str) –

    The name of the character.

  • rarity (int) –

    The rarity (star rating) of the character.

  • icon (str) –

    The URL to the character's standard avatar icon.

  • types (CharacterType) –

    Container for the character's Path and Combat Type enums.

  • route (str) –

    The API route for this character.

  • beta (bool) –

    Whether the character is currently in beta.

  • release_at (datetime | None) –

    Datetime object representing the release timestamp (optional).

Fields:

Validators:

beta pydantic-field 

beta: bool = False

icon pydantic-field 

icon: str

id pydantic-field 

id: int

large_icon property 

large_icon: str

Return the URL to the large-sized avatar icon (full splash art).

medium_icon property 

medium_icon: str

Return the URL to the medium-sized avatar icon.

name pydantic-field 

name: str

rarity pydantic-field 

rarity: int

release_at pydantic-field 

release_at: datetime | None = None

round_icon property 

round_icon: str

Return the URL to the round avatar icon.

route pydantic-field 

route: str

types pydantic-field 

types: CharacterType

CharacterAscensionItem pydantic-model

Represent an item and amount required for character ascension.

Attributes:

  • id (int) –

    The ID of the required item.

  • amount (int) –

    The amount of the item required.

Fields:

amount pydantic-field 

amount: int

id pydantic-field 

id: int

CharacterCostItem pydantic-model

Represent an item and amount required for character level upgrades.

Attributes:

  • id (int) –

    The ID of the required item.

  • amount (int) –

    The amount of the item required.

Fields:

amount pydantic-field 

amount: int

id pydantic-field 

id: int

CharacterDetail pydantic-model

Represent detailed information about a character.

Attributes:

Fields:

Validators:

ascension pydantic-field 

ascension: list[CharacterAscensionItem]

beta pydantic-field 

beta: bool = False

eidolons pydantic-field 

eidolons: list[CharacterEidolon]

icon pydantic-field 

icon: str

id pydantic-field 

id: int

info pydantic-field 

info: CharacterInfo

large_icon property 

large_icon: str

Return the URL to the large-sized avatar icon (full splash art).

medium_icon property 

medium_icon: str

Return the URL to the medium-sized avatar icon.

name pydantic-field 

name: str

rarity pydantic-field 

rarity: int

release pydantic-field 

release: int

release_at pydantic-field 

release_at: datetime | None = None

round_icon property 

round_icon: str

Return the URL to the round avatar icon.

route pydantic-field 

route: str

script pydantic-field 

script: CharacterScript

traces pydantic-field 

traces: CharacterTraces

types pydantic-field 

types: CharacterDetailTypes

upgrades pydantic-field 

upgrades: list[CharacterUpgrade]

CharacterDetailType pydantic-model

Represent either the Path or Combat Type with its ID and name.

Attributes:

  • id (str) –

    The identifier string (e.g., "Warrior", "Ice").

  • name (str) –

    The display name (e.g., "Destruction", "Ice").

Fields:

id pydantic-field 

id: str

name pydantic-field 

name: str

CharacterDetailTypes pydantic-model

Contain the character's Path and Combat Type details.

Attributes:

Fields:

combat_type pydantic-field 

combat_type: CharacterDetailType

path_type pydantic-field 

path_type: CharacterDetailType

CharacterEidolon pydantic-model

Represent a character Eidolon.

Attributes:

  • id (int) –

    The unique identifier for the Eidolon.

  • rank (int) –

    The rank of the Eidolon (1-6).

  • name (str) –

    The name of the Eidolon.

  • params (list[int | float] | None) –

    Parameters used for placeholder replacement in the description.

  • description (str) –

    The formatted description of the Eidolon's effect.

  • skill_add_level_list (list[SkillAdd]) –

    List of skills whose levels are increased by this Eidolon.

  • icon (str) –

    The URL to the Eidolon's icon.

Fields:

Validators:

description pydantic-field 

description: str

icon pydantic-field 

icon: str

id pydantic-field 

id: int

name pydantic-field 

name: str

params pydantic-field 

params: list[int | float] | None

rank pydantic-field 

rank: int

skill_add_level_list pydantic-field 

skill_add_level_list: list[SkillAdd]

List of skills that increase their level because of this eidolon

CharacterInfo pydantic-model

Represent additional information about a character (fetter info).

Attributes:

Fields:

Validators:

description pydantic-field 

description: str

faction pydantic-field 

faction: str | None

voice_actors pydantic-field 

voice_actors: list[VoiceActor]

CharacterScript pydantic-model

Contain character stories and voice lines.

Attributes:

Fields:

Validators:

stories pydantic-field 

stories: list[CharacterStory]

voices pydantic-field 

voices: list[CharacterVoice]

CharacterStory pydantic-model

Represent a piece of character story/lore.

Attributes:

  • title (str) –

    The title of the story section.

  • text (str) –

    The content of the story section.

Fields:

text pydantic-field 

text: str

title pydantic-field 

title: str

CharacterTraces pydantic-model

Contain all character traces (skills and passive abilities).

Attributes:

Fields:

Validators:

main_skills pydantic-field 

main_skills: list[BaseSkill]

sub_skills pydantic-field 

sub_skills: list[BaseSkill]

tree_skills pydantic-field 

tree_skills: list[SkillTree]

CharacterType pydantic-model

Contain the character's Path and Combat Type enums.

Attributes:

Fields:

combat_type pydantic-field 

combat_type: CombatType

path_type pydantic-field 

path_type: PathType

CharacterUpgrade pydantic-model

Represent the details for a specific character ascension rank.

Attributes:

Fields:

Validators:

cost_items pydantic-field 

cost_items: list[CharacterCostItem]

level pydantic-field 

level: int

max_level pydantic-field 

max_level: int

required_player_level pydantic-field 

required_player_level: int

required_world_level pydantic-field 

required_world_level: int

skill_add pydantic-field 

skill_add: dict[str, int | float]

skill_base pydantic-field 

skill_base: dict[str, int | float]

CharacterVoice pydantic-model

Represent a character voice line.

Attributes:

  • title (str) –

    The title or trigger condition of the voice line.

  • text (str) –

    The transcribed text of the voice line.

  • audio (int | None) –

    The ID or reference to the audio file (optional).

Fields:

audio pydantic-field 

audio: int | None

text pydantic-field 

text: str

title pydantic-field 

title: str

Contact pydantic-model

Represent a message contact.

Attributes:

  • name (str) –

    The name of the contact.

  • signature (str | None) –

    The signature of the contact (optional).

  • type (int) –

    The type identifier of the contact.

  • icon (str) –

    The URL to the contact's avatar icon.

Fields:

Validators:

  • __convert_icon → icon

icon pydantic-field 

icon: str

name pydantic-field 

name: str

signature pydantic-field 

signature: str | None = None

type pydantic-field 

type: int

ExtraEffect pydantic-model

Represent an extra effect associated with a skill.

Attributes:

  • name (str) –

    The name of the extra effect.

  • description (str) –

    The description of the extra effect.

  • icon (str) –

    The URL to the icon for the extra effect.

Fields:

description pydantic-field 

description: str

icon pydantic-field 

icon: str

name pydantic-field 

name: str

Item pydantic-model

Represent basic information about an item.

Attributes:

  • id (int) –

    The unique identifier for the item.

  • name (str) –

    The name of the item.

  • beta (bool) –

    Whether the item is currently in beta.

  • rarity (int) –

    The rarity (star rating) of the item.

  • type (int) –

    The numeric ID representing the item type.

  • tags (list[str]) –

    A list of tags associated with the item.

  • icon (str) –

    The URL to the item's icon.

  • route (str) –

    The API route for this item.

Fields:

Validators:

  • __coerce_tags → tags
  • __convert_icon → icon

beta pydantic-field 

beta: bool = False

icon pydantic-field 

icon: str

id pydantic-field 

id: int

name pydantic-field 

name: str

rarity pydantic-field 

rarity: int

route pydantic-field 

route: str

tags pydantic-field 

tags: list[str]

type pydantic-field 

type: int

ItemDetail pydantic-model

Represent detailed information about an item.

Attributes:

  • id (int) –

    The unique identifier for the item.

  • name (str) –

    The name of the item.

  • beta (bool) –

    Whether the item is currently in beta.

  • rarity (int) –

    The rarity (star rating) of the item.

  • tags (list[str]) –

    A list of tags associated with the item.

  • icon (str) –

    The URL to the item's icon.

  • route (str) –

    The API route for this item.

  • description (str) –

    The functional description of the item.

  • story (str | None) –

    The lore or background story of the item (optional).

  • sources (list[ItemSource]) –

    A list of sources where this item can be obtained.

Fields:

Validators:

  • __coerce_tags → tags
  • __convert_icon → icon
  • __convert_sources → sources

beta pydantic-field 

beta: bool = False

description pydantic-field 

description: str

icon pydantic-field 

icon: str

id pydantic-field 

id: int

name pydantic-field 

name: str

rarity pydantic-field 

rarity: int

route pydantic-field 

route: str

sources pydantic-field 

sources: list[ItemSource]

story pydantic-field 

story: str | None

tags pydantic-field 

tags: list[str]

ItemSource pydantic-model

Represent a source from which an item can be obtained.

Attributes:

Fields:

Validators:

description pydantic-field 

description: str

recipes pydantic-field 

recipes: list[Recipe]

ItemType pydantic-model

Represent the type of an item.

Attributes:

  • id (int) –

    The numeric ID of the item type.

  • name (str) –

    The display name of the item type.

Fields:

id pydantic-field 

id: int

name pydantic-field 

name: str

LightCone pydantic-model

Represent basic information about a light cone.

Attributes:

  • id (int) –

    The unique identifier for the light cone.

  • name (str) –

    The name of the light cone.

  • beta (bool) –

    Whether the light cone is currently in beta.

  • rarity (int) –

    The rarity (star rating) of the light cone.

  • icon (str) –

    The URL to the light cone's standard icon.

  • type (str) –

    The identifier string for the path type (e.g., "Warrior").

  • is_sellable (bool) –

    Whether the light cone can be sold.

  • route (str) –

    The API route for this light cone.

Fields:

Validators:

  • __convert_icon → icon
  • __convert_type → type

beta pydantic-field 

beta: bool = False

icon pydantic-field 

icon: str

id pydantic-field 

id: int

is_sellable pydantic-field 

is_sellable: bool

large_icon property 

large_icon: str

Return the URL to the large-sized icon.

medium_icon property 

medium_icon: str

Return the URL to the medium-sized icon.

name pydantic-field 

name: str

rarity pydantic-field 

rarity: int

route pydantic-field 

route: str

type pydantic-field 

type: str

LightConeAscensionMaterial pydantic-model

Represent a material required for light cone ascension.

Attributes:

  • id (int) –

    The ID of the ascension material item.

  • rarity (int) –

    The rarity of the ascension material item.

Fields:

id pydantic-field 

id: int

rarity pydantic-field 

rarity: int

LightConeCostItem pydantic-model

Represent an item and its amount required for upgrading a light cone.

Attributes:

  • id (int) –

    The ID of the required item.

  • amount (int) –

    The amount of the item required.

Fields:

amount pydantic-field 

amount: int

id pydantic-field 

id: int

LightConeDetail pydantic-model

Represent detailed information about a light cone.

Attributes:

Fields:

Validators:

ascension_materials pydantic-field 

ascension_materials: list[LightConeAscensionMaterial]

beta pydantic-field 

beta: bool = False

description pydantic-field 

description: str

icon pydantic-field 

icon: str

id pydantic-field 

id: int

is_sellable pydantic-field 

is_sellable: bool

large_icon property 

large_icon: str

Return the URL to the large-sized icon.

medium_icon property 

medium_icon: str

Return the URL to the medium-sized icon.

name pydantic-field 

name: str

rarity pydantic-field 

rarity: int

route pydantic-field 

route: str

skill pydantic-field 

skill: LightConeSkill

type pydantic-field 

type: LightConePathType

upgrades pydantic-field 

upgrades: list[LightConeUpgrade]

LightConePathType pydantic-model

Represent the path type of a light cone.

Attributes:

  • id (str) –

    The identifier string for the path type (e.g., "Warrior").

  • name (str) –

    The display name of the path type (e.g., "Destruction").

Fields:

id pydantic-field 

id: str

name pydantic-field 

name: str

LightConeSkill pydantic-model

Represent the skill of a light cone.

Attributes:

  • name (str) –

    The name of the light cone skill.

  • description (str) –

    The description of the light cone skill.

  • params (dict[str, list[int | float]]) –

    Parameters associated with the skill's effects, often scaling with superimposition.

Fields:

description pydantic-field 

description: str

name pydantic-field 

name: str

params pydantic-field 

params: dict[str, list[int | float]]

LightConeUpgrade pydantic-model

Represent the details for a specific ascension level of a light cone.

Attributes:

Fields:

Validators:

cost_items pydantic-field 

cost_items: list[LightConeCostItem]

level pydantic-field 

level: int

max_level pydantic-field 

max_level: int

required_player_level pydantic-field 

required_player_level: int

required_world_level pydantic-field 

required_world_level: int

skill_add pydantic-field 

skill_add: dict[str, int | float]

skill_base pydantic-field 

skill_base: dict[str, int | float]

Message pydantic-model

Represent a message thread or conversation.

Attributes:

  • id (int) –

    The unique identifier for the message thread.

  • contact (Contact) –

    The contact associated with this message thread.

  • section_count (int) –

    The number of sections or messages in the thread.

  • route (str | None) –

    The API route for this message thread (optional).

Fields:

contact pydantic-field 

contact: Contact

id pydantic-field 

id: int

route pydantic-field 

route: str | None = None

section_count pydantic-field 

section_count: int

Recipe pydantic-model

Represent a recipe to craft or obtain an item.

Attributes:

Fields:

Validators:

coin_cost pydantic-field 

coin_cost: int

materials pydantic-field 

materials: list[RecipeMaterial]

required_world_level pydantic-field 

required_world_level: int

special_materials pydantic-field 

special_materials: list[RecipeMaterial]

RecipeMaterial pydantic-model

Represent a material required for a recipe.

Attributes:

  • id (int) –

    The ID of the material item.

  • rarity (int) –

    The rarity of the material item.

  • icon (str) –

    The URL to the material item's icon.

  • amount (int) –

    The amount of the material required.

Fields:

Validators:

  • __convert_icon → icon

amount pydantic-field 

amount: int

icon pydantic-field 

icon: str

id pydantic-field 

id: int

rarity pydantic-field 

rarity: int

Relic pydantic-model

Represent a single relic piece.

Attributes:

  • pos (str) –

    The position/slot of the relic (e.g., "HEAD", "HAND").

  • name (str) –

    The name of the relic piece.

  • description (str) –

    The description of the relic piece.

  • story (str) –

    The lore or story associated with the relic piece.

  • icon (str) –

    The URL to the relic piece's icon.

Fields:

Validators:

  • __convert_icon → icon

description pydantic-field 

description: str

icon pydantic-field 

icon: str

name pydantic-field 

name: str

pos pydantic-field 

pos: str

story pydantic-field 

story: str

RelicSet pydantic-model

Represent basic information about a relic set.

Attributes:

  • id (int) –

    The unique identifier for the relic set.

  • name (str) –

    The name of the relic set.

  • beta (bool) –

    Whether the relic set is currently in beta.

  • icon (str) –

    The URL to the relic set's icon.

  • rarity_list (list[int]) –

    A list of rarities this set is available in.

  • is_planar_suit (bool) –

    Whether the set is a Planar Ornament set.

  • route (str) –

    The API route for this relic set.

Fields:

Validators:

  • __convert_icon → icon

beta pydantic-field 

beta: bool = False

icon pydantic-field 

icon: str

id pydantic-field 

id: int

is_planar_suit pydantic-field 

is_planar_suit: bool

name pydantic-field 

name: str

rarity_list pydantic-field 

rarity_list: list[int]

route pydantic-field 

route: str

RelicSetDetail pydantic-model

Represent detailed information about a relic set.

Attributes:

  • id (int) –

    The unique identifier for the relic set.

  • name (str) –

    The name of the relic set.

  • icon (str) –

    The URL to the relic set's icon.

  • rarity_list (list[int]) –

    A list of rarities this set is available in.

  • is_planar_suit (bool) –

    Whether the set is a Planar Ornament set.

  • route (str) –

    The API route for this relic set.

  • beta (bool) –

    Whether the relic set is currently in beta.

  • set_effects (SetEffects) –

    The 2-piece and 4-piece effects of the set.

  • relics (list[Relic]) –

    A list of individual relic pieces belonging to this set.

Fields:

Validators:

  • __convert_icon → icon
  • __convert_relics → relics

beta pydantic-field 

beta: bool = False

icon pydantic-field 

icon: str

id pydantic-field 

id: int

is_planar_suit pydantic-field 

is_planar_suit: bool

name pydantic-field 

name: str

rarity_list pydantic-field 

rarity_list: list[int]

relics pydantic-field 

relics: list[Relic]

route pydantic-field 

route: str

set_effects pydantic-field 

set_effects: SetEffects

SetEffect pydantic-model

Represent a set effect for a relic set.

Attributes:

Fields:

Validators:

description pydantic-field 

description: str

params pydantic-field 

params: dict[str, list[int | float]] | None

SetEffects pydantic-model

Contain the 2-piece and 4-piece set effects.

Attributes:

  • two_piece (SetEffect) –

    The effect activated when 2 pieces of the set are equipped.

  • four_piece (SetEffect | None) –

    The effect activated when 4 pieces of the set are equipped (optional).

Fields:

four_piece pydantic-field 

four_piece: SetEffect | None = None

two_piece pydantic-field 

two_piece: SetEffect

SkillAdd pydantic-model

Represent a skill level increase granted by an Eidolon.

Attributes:

  • id (int) –

    ID of the skill whose level is increased.

  • level (int) –

    The number of levels added to the skill.

Fields:

id pydantic-field 

id: int

ID of the skill

level pydantic-field 

level: int

Level added to the skill

SkillListSkill pydantic-model

Represent detailed information about a specific character skill (Basic ATK, Skill, Ultimate, Talent).

Attributes:

Fields:

Validators:

attack_type pydantic-field 

attack_type: str | None

damage_type pydantic-field 

damage_type: str | None

description pydantic-field 

description: str | None

eidolons pydantic-field 

eidolons: list[int]

extra_effects pydantic-field 

extra_effects: list[ExtraEffect]

icon pydantic-field 

icon: str

id pydantic-field 

id: int

max_level pydantic-field 

max_level: int

name pydantic-field 

name: str

params pydantic-field 

params: dict[str, list[float]] | None

simplified_description pydantic-field 

simplified_description: str | None

skill_points pydantic-field 

skill_points: list[SkillPoint]

tag pydantic-field 

tag: str | None

traces pydantic-field 

traces: list[int]

type pydantic-field 

type: str

weakness_break pydantic-field 

weakness_break: list[WeaknessBreak]

SkillPoint pydantic-model

Represent skill point generation or consumption by a skill.

Attributes:

  • type (str) –

    The type of skill point interaction (e.g., "SkillPoint", "EnergyGenerate").

  • value (int | None) –

    The amount of skill points generated (positive) or consumed (negative), or energy generated.

Fields:

type pydantic-field 

type: str

value pydantic-field 

value: int | None

SkillPromote pydantic-model

Represent the cost to promote (level up) a skill/trace to a specific level.

Attributes:

Fields:

Validators:

cost_items pydantic-field 

cost_items: list[SkillPromoteCostItem]

level pydantic-field 

level: int

SkillPromoteCostItem pydantic-model

Represent an item and amount required for promoting (leveling up) a skill/trace.

Attributes:

  • id (int) –

    The ID of the required item.

  • amount (int) –

    The amount of the item required.

Fields:

amount pydantic-field 

amount: int

id pydantic-field 

id: int

SkillTree pydantic-model

Represent a skill tree structure for a character.

Attributes:

Fields:

Validators:

  • __convert_tree → tree

id pydantic-field 

id: int

tree pydantic-field 

tree: list[SkillTreeSkill] = []

type pydantic-field 

type: str

SkillTreeSkill pydantic-model

Represent a connection or node within a skill tree structure.

Attributes:

  • id (int) –

    The ID of the skill/trace node this connection points to or represents.

  • points_direction (str | None) –

    The direction of the connection (optional).

  • points (list[int]) –

    A list of connected skill/trace node IDs.

Fields:

Validators:

id pydantic-field 

id: int

points pydantic-field 

points: list[int]

points_direction pydantic-field 

points_direction: str | None

Status pydantic-model

Represent a status effect or stat bonus granted by a trace node.

Attributes:

  • name (str) –

    The name of the status or stat (e.g., "HPAddedRatio").

  • value (int | float) –

    The value of the status or stat bonus.

  • icon (str) –

    The URL to the icon representing the status or stat.

Fields:

Validators:

  • __convert_icon → icon

icon pydantic-field 

icon: str

name pydantic-field 

name: str

value pydantic-field 

value: int | float

VoiceActor pydantic-model

Represent a voice actor for a specific language.

Attributes:

  • lang (str) –

    The language code (e.g., "en", "jp").

  • name (str | None) –

    The name of the voice actor.

Fields:

lang pydantic-field 

lang: str

name pydantic-field 

name: str | None

WeaknessBreak pydantic-model

Represent the toughness damage dealt by a skill.

Attributes:

  • type (str) –

    The type of weakness break (e.g., "Skill").

  • value (int) –

    The amount of toughness damage dealt.

Fields:

type pydantic-field 

type: str

value pydantic-field 

value: int