kittycad
  • kittycad.KittyCAD
  • kittycad.AsyncKittyCAD
  • kittycad.client
  • kittycad.models
    • kittycad.models.account_provider
    • kittycad.models.add_hole_from_offset
    • kittycad.models.add_org_member
    • kittycad.models.address_details
    • kittycad.models.adjacency_info
    • kittycad.models.angle
    • kittycad.models.annotation_line_end
    • kittycad.models.annotation_line_end_options
    • kittycad.models.annotation_options
    • kittycad.models.annotation_text_alignment_x
    • kittycad.models.annotation_text_alignment_y
    • kittycad.models.annotation_text_options
    • kittycad.models.annotation_type
    • kittycad.models.api_call_query_group
    • kittycad.models.api_call_query_group_by
    • kittycad.models.api_call_status
    • kittycad.models.api_call_with_price
    • kittycad.models.api_call_with_price_results_page
    • kittycad.models.api_endpoint
    • kittycad.models.api_error
    • kittycad.models.api_token
    • kittycad.models.api_token_results_page
    • kittycad.models.api_token_uuid
    • kittycad.models.app_client_info
    • kittycad.models.async_api_call
    • kittycad.models.async_api_call_output
    • kittycad.models.async_api_call_results_page
    • kittycad.models.async_api_call_type
    • kittycad.models.auth_api_key_response
    • kittycad.models.auth_callback
    • kittycad.models.axis
    • kittycad.models.axis_direction_pair
    • kittycad.models.base
    • kittycad.models.base64data
    • kittycad.models.batch_response
    • kittycad.models.billing_info
    • kittycad.models.block_reason
    • kittycad.models.boolean_intersection
    • kittycad.models.boolean_subtract
    • kittycad.models.boolean_union
    • kittycad.models.camera_drag_end
    • kittycad.models.camera_drag_interaction_type
    • kittycad.models.camera_drag_move
    • kittycad.models.camera_drag_start
    • kittycad.models.camera_movement
    • kittycad.models.camera_settings
    • kittycad.models.camera_view_state
    • kittycad.models.card_details
    • kittycad.models.center_of_mass
    • kittycad.models.client_metrics
    • kittycad.models.close_path
    • kittycad.models.code_language
    • kittycad.models.code_option
    • kittycad.models.code_output
    • kittycad.models.color
    • kittycad.models.complementary_edges
    • kittycad.models.component_transform
    • kittycad.models.conversation
    • kittycad.models.conversation_results_page
    • kittycad.models.conversion_params
    • kittycad.models.country_code
    • kittycad.models.coupon
    • kittycad.models.create_shortlink_request
    • kittycad.models.create_shortlink_response
    • kittycad.models.created_at_sort_mode
    • kittycad.models.crm_data
    • kittycad.models.currency
    • kittycad.models.curve_get_control_points
    • kittycad.models.curve_get_end_points
    • kittycad.models.curve_get_type
    • kittycad.models.curve_set_constraint
    • kittycad.models.curve_type
    • kittycad.models.customer
    • kittycad.models.customer_balance
    • kittycad.models.cut_strategy
    • kittycad.models.cut_type
    • kittycad.models.default_camera_center_to_scene
    • kittycad.models.default_camera_center_to_selection
    • kittycad.models.default_camera_focus_on
    • kittycad.models.default_camera_get_settings
    • kittycad.models.default_camera_get_view
    • kittycad.models.default_camera_look_at
    • kittycad.models.default_camera_perspective_settings
    • kittycad.models.default_camera_set_orthographic
    • kittycad.models.default_camera_set_perspective
    • kittycad.models.default_camera_set_view
    • kittycad.models.default_camera_zoom
    • kittycad.models.density
    • kittycad.models.der_encoded_key_pair
    • kittycad.models.device_access_token_request_form
    • kittycad.models.device_access_token_uuid
    • kittycad.models.device_auth_confirm_params
    • kittycad.models.device_auth_request_form
    • kittycad.models.direction
    • kittycad.models.disable_dry_run
    • kittycad.models.discount
    • kittycad.models.discount_code
    • kittycad.models.distance_type
    • kittycad.models.dxf_storage
    • kittycad.models.edge_info
    • kittycad.models.edge_lines_visible
    • kittycad.models.email_authentication_form
    • kittycad.models.empty
    • kittycad.models.enable_dry_run
    • kittycad.models.enable_sketch_mode
    • kittycad.models.engine_util_evaluate_path
    • kittycad.models.enterprise_subscription_tier_price
    • kittycad.models.entity_circular_pattern
    • kittycad.models.entity_clone
    • kittycad.models.entity_fade
    • kittycad.models.entity_get_all_child_uuids
    • kittycad.models.entity_get_child_uuid
    • kittycad.models.entity_get_distance
    • kittycad.models.entity_get_num_children
    • kittycad.models.entity_get_parent_id
    • kittycad.models.entity_get_sketch_paths
    • kittycad.models.entity_linear_pattern
    • kittycad.models.entity_linear_pattern_transform
    • kittycad.models.entity_make_helix
    • kittycad.models.entity_make_helix_from_edge
    • kittycad.models.entity_make_helix_from_params
    • kittycad.models.entity_mirror
    • kittycad.models.entity_mirror_across_edge
    • kittycad.models.entity_set_opacity
    • kittycad.models.entity_type
    • kittycad.models.error
    • kittycad.models.error_code
    • kittycad.models.event
    • kittycad.models.export
    • kittycad.models.export2d
    • kittycad.models.export3d
    • kittycad.models.export_file
    • kittycad.models.extend_path
    • kittycad.models.extended_user
    • kittycad.models.extended_user_results_page
    • kittycad.models.extrude
    • kittycad.models.extrude_method
    • kittycad.models.extruded_face_info
    • kittycad.models.extrusion_face_cap_type
    • kittycad.models.extrusion_face_info
    • kittycad.models.face_edge_info
    • kittycad.models.face_get_center
    • kittycad.models.face_get_gradient
    • kittycad.models.face_get_position
    • kittycad.models.face_is_planar
    • kittycad.models.failure_web_socket_response
    • kittycad.models.fbx_storage
    • kittycad.models.file_center_of_mass
    • kittycad.models.file_conversion
    • kittycad.models.file_density
    • kittycad.models.file_export_format
    • kittycad.models.file_import_format
    • kittycad.models.file_mass
    • kittycad.models.file_surface_area
    • kittycad.models.file_volume
    • kittycad.models.get_entity_type
    • kittycad.models.get_num_objects
    • kittycad.models.get_sketch_mode_plane
    • kittycad.models.global_axis
    • kittycad.models.gltf_presentation
    • kittycad.models.gltf_storage
    • kittycad.models.handle_mouse_drag_end
    • kittycad.models.handle_mouse_drag_move
    • kittycad.models.handle_mouse_drag_start
    • kittycad.models.highlight_set_entities
    • kittycad.models.highlight_set_entity
    • kittycad.models.ice_server
    • kittycad.models.idp_metadata_source
    • kittycad.models.image_format
    • kittycad.models.import_file
    • kittycad.models.import_files
    • kittycad.models.imported_geometry
    • kittycad.models.input_format3d
    • kittycad.models.inquiry_form
    • kittycad.models.inquiry_type
    • kittycad.models.invoice
    • kittycad.models.invoice_line_item
    • kittycad.models.invoice_status
    • kittycad.models.ip_addr_info
    • kittycad.models.kcl_code_completion_params
    • kittycad.models.kcl_code_completion_request
    • kittycad.models.kcl_code_completion_response
    • kittycad.models.kcl_model
    • kittycad.models.length_unit
    • kittycad.models.loft
    • kittycad.models.make_axes_gizmo
    • kittycad.models.make_offset_path
    • kittycad.models.make_plane
    • kittycad.models.mass
    • kittycad.models.method
    • kittycad.models.ml_copilot_client_message
    • kittycad.models.ml_copilot_server_message
    • kittycad.models.ml_copilot_system_command
    • kittycad.models.ml_feedback
    • kittycad.models.ml_prompt
    • kittycad.models.ml_prompt_metadata
    • kittycad.models.ml_prompt_results_page
    • kittycad.models.ml_prompt_type
    • kittycad.models.ml_tool_result
    • kittycad.models.modeling_app_event_type
    • kittycad.models.modeling_app_individual_subscription_tier
    • kittycad.models.modeling_app_organization_subscription_tier
    • kittycad.models.modeling_app_share_links
    • kittycad.models.modeling_app_subscription_tier
    • kittycad.models.modeling_app_subscription_tier_name
    • kittycad.models.modeling_cmd
    • kittycad.models.modeling_cmd_id
    • kittycad.models.modeling_cmd_req
    • kittycad.models.modeling_session_data
    • kittycad.models.mouse_click
    • kittycad.models.mouse_move
    • kittycad.models.move_path_pen
    • kittycad.models.new_annotation
    • kittycad.models.oauth2_client_info
    • kittycad.models.oauth2_grant_type
    • kittycad.models.object_bring_to_front
    • kittycad.models.object_set_material_params_pbr
    • kittycad.models.object_visible
    • kittycad.models.ok_modeling_cmd_response
    • kittycad.models.ok_web_socket_response_data
    • kittycad.models.opposite_for_angle
    • kittycad.models.opposite_for_length_unit
    • kittycad.models.org
    • kittycad.models.org_details
    • kittycad.models.org_member
    • kittycad.models.org_member_results_page
    • kittycad.models.org_results_page
    • kittycad.models.org_role
    • kittycad.models.orient_to_face
    • kittycad.models.origin_type
    • kittycad.models.output_file
    • kittycad.models.output_format2d
    • kittycad.models.output_format3d
    • kittycad.models.path_command
    • kittycad.models.path_component_constraint_bound
    • kittycad.models.path_component_constraint_type
    • kittycad.models.path_get_curve_uuid
    • kittycad.models.path_get_curve_uuids_for_vertices
    • kittycad.models.path_get_info
    • kittycad.models.path_get_sketch_target_uuid
    • kittycad.models.path_get_vertex_uuids
    • kittycad.models.path_segment
    • kittycad.models.path_segment_info
    • kittycad.models.payment_intent
    • kittycad.models.payment_method
    • kittycad.models.payment_method_card_checks
    • kittycad.models.payment_method_type
    • kittycad.models.perspective_camera_parameters
    • kittycad.models.plan_interval
    • kittycad.models.plane_intersect_and_project
    • kittycad.models.plane_set_color
    • kittycad.models.ply_storage
    • kittycad.models.point2d
    • kittycad.models.point3d
    • kittycad.models.point4d
    • kittycad.models.pong
    • kittycad.models.post_effect_type
    • kittycad.models.privacy_settings
    • kittycad.models.project_entity_to_plane
    • kittycad.models.project_points_to_plane
    • kittycad.models.raw_file
    • kittycad.models.reasoning_message
    • kittycad.models.reconfigure_stream
    • kittycad.models.relative_to
    • kittycad.models.remove_scene_objects
    • kittycad.models.revolve
    • kittycad.models.revolve_about_edge
    • kittycad.models.rotation
    • kittycad.models.rtc_ice_candidate_init
    • kittycad.models.rtc_sdp_type
    • kittycad.models.rtc_session_description
    • kittycad.models.saml_identity_provider
    • kittycad.models.saml_identity_provider_create
    • kittycad.models.scene_clear_all
    • kittycad.models.scene_selection_type
    • kittycad.models.scene_tool_type
    • kittycad.models.select_add
    • kittycad.models.select_clear
    • kittycad.models.select_get
    • kittycad.models.select_remove
    • kittycad.models.select_replace
    • kittycad.models.select_with_point
    • kittycad.models.selection
    • kittycad.models.send_object
    • kittycad.models.service_account
    • kittycad.models.service_account_results_page
    • kittycad.models.service_account_uuid
    • kittycad.models.session
    • kittycad.models.session_uuid
    • kittycad.models.set_background_color
    • kittycad.models.set_current_tool_properties
    • kittycad.models.set_default_system_properties
    • kittycad.models.set_grid_auto_scale
    • kittycad.models.set_grid_reference_plane
    • kittycad.models.set_grid_scale
    • kittycad.models.set_object_transform
    • kittycad.models.set_scene_units
    • kittycad.models.set_selection_filter
    • kittycad.models.set_selection_type
    • kittycad.models.set_tool
    • kittycad.models.shortlink
    • kittycad.models.shortlink_results_page
      • kittycad.models.shortlink_results_page.ShortlinkResultsPage
      • ShortlinkResultsPage
        • ShortlinkResultsPage.construct()
        • ShortlinkResultsPage.copy()
        • ShortlinkResultsPage.dict()
        • ShortlinkResultsPage.from_dict()
        • ShortlinkResultsPage.from_json()
        • ShortlinkResultsPage.from_orm()
        • ShortlinkResultsPage.items
        • ShortlinkResultsPage.json()
        • ShortlinkResultsPage.model_computed_fields
        • ShortlinkResultsPage.model_config
        • ShortlinkResultsPage.model_construct()
        • ShortlinkResultsPage.model_copy()
        • ShortlinkResultsPage.model_dump()
        • ShortlinkResultsPage.model_dump_json()
        • ShortlinkResultsPage.model_extra
        • ShortlinkResultsPage.model_fields
        • ShortlinkResultsPage.model_fields_set
        • ShortlinkResultsPage.model_json_schema()
        • ShortlinkResultsPage.model_parametrized_name()
        • ShortlinkResultsPage.model_post_init()
        • ShortlinkResultsPage.model_rebuild()
        • ShortlinkResultsPage.model_validate()
        • ShortlinkResultsPage.model_validate_json()
        • ShortlinkResultsPage.model_validate_strings()
        • ShortlinkResultsPage.next_page
        • ShortlinkResultsPage.parse_file()
        • ShortlinkResultsPage.parse_obj()
        • ShortlinkResultsPage.parse_raw()
        • ShortlinkResultsPage.schema()
        • ShortlinkResultsPage.schema_json()
        • ShortlinkResultsPage.to_dict()
        • ShortlinkResultsPage.to_json()
        • ShortlinkResultsPage.update_forward_refs()
        • ShortlinkResultsPage.validate()
    • kittycad.models.side_face
    • kittycad.models.sketch_mode_disable
    • kittycad.models.solid2d_add_hole
    • kittycad.models.solid3d_fillet_edge
    • kittycad.models.solid3d_get_adjacency_info
    • kittycad.models.solid3d_get_all_edge_faces
    • kittycad.models.solid3d_get_all_opposite_edges
    • kittycad.models.solid3d_get_common_edge
    • kittycad.models.solid3d_get_extrusion_face_info
    • kittycad.models.solid3d_get_next_adjacent_edge
    • kittycad.models.solid3d_get_opposite_edge
    • kittycad.models.solid3d_get_prev_adjacent_edge
    • kittycad.models.solid3d_shell_face
    • kittycad.models.source_position
    • kittycad.models.source_range
    • kittycad.models.source_range_prompt
    • kittycad.models.start_path
    • kittycad.models.stl_storage
    • kittycad.models.store_coupon_params
    • kittycad.models.subscribe
    • kittycad.models.subscription_tier_feature
    • kittycad.models.subscription_tier_price
    • kittycad.models.subscription_tier_type
    • kittycad.models.subscription_training_data_behavior
    • kittycad.models.success_web_socket_response
    • kittycad.models.support_tier
    • kittycad.models.surface_area
    • kittycad.models.sweep
    • kittycad.models.system
    • kittycad.models.take_snapshot
    • kittycad.models.text_to_cad
    • kittycad.models.text_to_cad_create_body
    • kittycad.models.text_to_cad_iteration
    • kittycad.models.text_to_cad_iteration_body
    • kittycad.models.text_to_cad_model
    • kittycad.models.text_to_cad_multi_file_iteration
    • kittycad.models.text_to_cad_multi_file_iteration_body
    • kittycad.models.text_to_cad_response
    • kittycad.models.text_to_cad_response_results_page
    • kittycad.models.token_revoke_request_form
    • kittycad.models.transform
    • kittycad.models.transform_by_for_point3d
    • kittycad.models.transform_by_for_point4d
    • kittycad.models.twist_extrude
    • kittycad.models.unit_angle
    • kittycad.models.unit_angle_conversion
    • kittycad.models.unit_area
    • kittycad.models.unit_area_conversion
    • kittycad.models.unit_current
    • kittycad.models.unit_current_conversion
    • kittycad.models.unit_density
    • kittycad.models.unit_energy
    • kittycad.models.unit_energy_conversion
    • kittycad.models.unit_force
    • kittycad.models.unit_force_conversion
    • kittycad.models.unit_frequency
    • kittycad.models.unit_frequency_conversion
    • kittycad.models.unit_length
    • kittycad.models.unit_length_conversion
    • kittycad.models.unit_mass
    • kittycad.models.unit_mass_conversion
    • kittycad.models.unit_power
    • kittycad.models.unit_power_conversion
    • kittycad.models.unit_pressure
    • kittycad.models.unit_pressure_conversion
    • kittycad.models.unit_temperature
    • kittycad.models.unit_temperature_conversion
    • kittycad.models.unit_torque
    • kittycad.models.unit_torque_conversion
    • kittycad.models.unit_volume
    • kittycad.models.unit_volume_conversion
    • kittycad.models.update_annotation
    • kittycad.models.update_member_to_org_body
    • kittycad.models.update_payment_balance
    • kittycad.models.update_shortlink_request
    • kittycad.models.update_user
    • kittycad.models.user
    • kittycad.models.user_identifier
    • kittycad.models.user_org_info
    • kittycad.models.user_org_role
    • kittycad.models.user_results_page
    • kittycad.models.uuid
    • kittycad.models.verification_token_response
    • kittycad.models.view_isometric
    • kittycad.models.volume
    • kittycad.models.web_socket_request
    • kittycad.models.web_socket_response
    • kittycad.models.world_coordinate_system
    • kittycad.models.zoo_product_subscription
    • kittycad.models.zoo_product_subscriptions
    • kittycad.models.zoo_product_subscriptions_org_request
    • kittycad.models.zoo_product_subscriptions_user_request
    • kittycad.models.zoo_tool
    • kittycad.models.zoom_to_fit
  • kittycad.types
  • kittycad.pagination

Contents:

  • Pagination
kittycad
  • kittycad.models
  • kittycad.models.shortlink_results_page

kittycad.models.shortlink_results_page

Classes

ShortlinkResultsPage(**data)

A single page of results

class kittycad.models.shortlink_results_page.ShortlinkResultsPage(**data)[source][source]

A single page of results

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

classmethod construct(_fields_set=None, **values)[source]
Return type:

Self

copy(*, include=None, exclude=None, update=None, deep=False)[source]

Returns a copy of the model.

!!! warning “Deprecated”

This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:
  • include – Optional set or mapping specifying which fields to include in the copied model.

  • exclude – Optional set or mapping specifying which fields to exclude in the copied model.

  • update – Optional dictionary of field-value pairs to override field values in the copied model.

  • deep – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)[source]
Return type:

Dict[str, Any]

classmethod from_dict(data)[source]

Create model instance from dictionary.

Parameters:

data (Dict[str, Any]) – Dictionary containing model data.

Return type:

KittyCadBaseModel

Returns:

Model instance.

Example

user_data = {“id”: “123”, “name”: “John”} user = User.from_dict(user_data)

classmethod from_json(json_str)[source]

Create model instance from JSON string.

Parameters:

json_str (str) – JSON string containing model data.

Return type:

KittyCadBaseModel

Returns:

Model instance.

Example

user_json = ‘{“id”: “123”, “name”: “John”}’ user = User.from_json(user_json)

classmethod from_orm(obj)[source]
Return type:

Self

items: List[Shortlink][source]
json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)[source]
Return type:

str

model_computed_fields = {}[source]
model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'protected_namespaces': (), 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}[source]

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)[source]

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == 'allow', then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == 'ignore' (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == 'forbid' does not result in an error if extra values are passed, but they will be ignored.

Parameters:
  • _fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

  • values (Any) – Trusted or pre-validated data dictionary.

Return type:

Self

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)[source]
!!! abstract “Usage Documentation”

[model_copy](../concepts/serialization.md#model_copy)

Returns a copy of the model.

!!! note

The underlying instance’s [__dict__][object.__dict__] attribute is copied. This might have unexpected side effects if you store anything in it, on top of the model fields (e.g. the value of [cached properties][functools.cached_property]).

Parameters:
  • update (Mapping[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.

  • deep (bool) – Set to True to make a deep copy of the model.

Return type:

Self

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, fallback=None, serialize_as_any=False)[source]
!!! abstract “Usage Documentation”

[model_dump](../concepts/serialization.md#modelmodel_dump)

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:
  • mode (Union[Literal['json', 'python'], str]) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.

  • include (Union[set[int], set[str], Mapping[int, Union[set[int], set[str], Mapping[int, Union[IncEx, bool]], Mapping[str, Union[IncEx, bool]], bool]], Mapping[str, Union[set[int], set[str], Mapping[int, Union[IncEx, bool]], Mapping[str, Union[IncEx, bool]], bool]], None]) – A set of fields to include in the output.

  • exclude (Union[set[int], set[str], Mapping[int, Union[set[int], set[str], Mapping[int, Union[IncEx, bool]], Mapping[str, Union[IncEx, bool]], bool]], Mapping[str, Union[set[int], set[str], Mapping[int, Union[IncEx, bool]], Mapping[str, Union[IncEx, bool]], bool]], None]) – A set of fields to exclude from the output.

  • context (Any | None) – Additional context to pass to the serializer.

  • by_alias (bool | None) – Whether to use the field’s alias in the dictionary key if defined.

  • exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.

  • exclude_defaults (bool) – Whether to exclude fields that are set to their default value.

  • exclude_none (bool) – Whether to exclude fields that have a value of None.

  • round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].

  • warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].

  • fallback (Optional[Callable[[Any], Any]]) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.

  • serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

dict[str, Any]

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, include=None, exclude=None, context=None, by_alias=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, round_trip=False, warnings=True, fallback=None, serialize_as_any=False)[source]
!!! abstract “Usage Documentation”

[model_dump_json](../concepts/serialization.md#modelmodel_dump_json)

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:
  • indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.

  • include (Union[set[int], set[str], Mapping[int, Union[set[int], set[str], Mapping[int, Union[IncEx, bool]], Mapping[str, Union[IncEx, bool]], bool]], Mapping[str, Union[set[int], set[str], Mapping[int, Union[IncEx, bool]], Mapping[str, Union[IncEx, bool]], bool]], None]) – Field(s) to include in the JSON output.

  • exclude (Union[set[int], set[str], Mapping[int, Union[set[int], set[str], Mapping[int, Union[IncEx, bool]], Mapping[str, Union[IncEx, bool]], bool]], Mapping[str, Union[set[int], set[str], Mapping[int, Union[IncEx, bool]], Mapping[str, Union[IncEx, bool]], bool]], None]) – Field(s) to exclude from the JSON output.

  • context (Any | None) – Additional context to pass to the serializer.

  • by_alias (bool | None) – Whether to serialize using field aliases.

  • exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.

  • exclude_defaults (bool) – Whether to exclude fields that are set to their default value.

  • exclude_none (bool) – Whether to exclude fields that have a value of None.

  • round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].

  • warnings (Union[bool, Literal['none', 'warn', 'error']]) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].

  • fallback (Optional[Callable[[Any], Any]]) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.

  • serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.

Return type:

str

Returns:

A JSON string representation of the model.

property model_extra: dict[str, Any] | None[source]

Get extra fields set during validation.

Returns:

A dictionary of extra fields, or None if config.extra is not set to "allow".

model_fields = {'items': FieldInfo(annotation=List[Shortlink], required=True), 'next_page': FieldInfo(annotation=Union[str, NoneType], required=False, default=None)}[source]
property model_fields_set: set[str][source]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,

i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation')[source]

Generates a JSON schema for a model class.

Parameters:
  • by_alias (bool) – Whether to use attribute aliases or not.

  • ref_template (str) – The reference template.

  • schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications

  • mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Return type:

dict[str, Any]

Returns:

The JSON schema for the given model class.

classmethod model_parametrized_name(params)[source]

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:

params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.

Return type:

str

Returns:

String representing the new class where params are passed to cls as type variables.

Raises:

TypeError – Raised when trying to generate concrete names for non-generic models.

model_post_init(context, /)[source]

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Return type:

None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)[source]

Try to rebuild the pydantic-core schema for the model.

This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.

Parameters:
  • force (bool) – Whether to force the rebuilding of the model schema, defaults to False.

  • raise_errors (bool) – Whether to raise errors, defaults to True.

  • _parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.

  • _types_namespace (Mapping[str, Any] | None) – The types namespace, defaults to None.

Return type:

bool | None

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, from_attributes=None, context=None, by_alias=None, by_name=None)[source]

Validate a pydantic model instance.

Parameters:
  • obj (Any) – The object to validate.

  • strict (bool | None) – Whether to enforce types strictly.

  • from_attributes (bool | None) – Whether to extract data from object attributes.

  • context (Any | None) – Additional context to pass to the validator.

  • by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.

  • by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Raises:

ValidationError – If the object could not be validated.

Return type:

Self

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, context=None, by_alias=None, by_name=None)[source]
!!! abstract “Usage Documentation”

[JSON Parsing](../concepts/json.md#json-parsing)

Validate the given JSON data against the Pydantic model.

Parameters:
  • json_data (str | bytes | bytearray) – The JSON data to validate.

  • strict (bool | None) – Whether to enforce types strictly.

  • context (Any | None) – Extra variables to pass to the validator.

  • by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.

  • by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Return type:

Self

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, context=None, by_alias=None, by_name=None)[source]

Validate the given object with string data against the Pydantic model.

Parameters:
  • obj (Any) – The object containing string data to validate.

  • strict (bool | None) – Whether to enforce types strictly.

  • context (Any | None) – Extra variables to pass to the validator.

  • by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.

  • by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Return type:

Self

Returns:

The validated Pydantic model.

next_page: Optional[str][source]
classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]
Return type:

Self

classmethod parse_obj(obj)[source]
Return type:

Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)[source]
Return type:

Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')[source]
Return type:

Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)[source]
Return type:

str

to_dict()[source]

Convert model to dictionary with alias support.

Return type:

Dict[str, Any]

Returns:

Dictionary representation of the model.

to_json()[source]

Convert model to JSON string with alias support.

Return type:

str

Returns:

JSON string representation of the model.

classmethod update_forward_refs(**localns)[source]
Return type:

None

classmethod validate(value)[source]
Return type:

Self

Previous Next

© Copyright 2025, KittyCAD Team Members.

Built with Sphinx using a theme provided by Read the Docs.