Search Endpoints¶

Search API endpoints.

Overview¶

Method	Endpoint	Description
GET	`/api/v1/search/`	Global Search

API Reference¶

Sartiq Backend Server - Search 0.1.0¶

search¶

GET /api/v1/search/¶

Global Search

Description

Search across Products, Shootings, ShootingLooks, and Subjects.

Returns a flat list of typed results, each with a resource_type discriminator and typed data payload. Results are capped at limit per resource type.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`limit`	query	integer	5	No	Max results per resource type
`organization_id`	query			No
`q`	query	string		No	Search query

Responses

200 OK422 Unprocessable Entity

application/json

{
    "results": [
        null
    ],
    "count": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "results": {
            "items": {
                "anyOf": [
                    {
                        "$ref": "#/components/schemas/ProductSearchResult"
                    },
                    {
                        "$ref": "#/components/schemas/ShootingSearchResult"
                    },
                    {
                        "$ref": "#/components/schemas/ShootingLookSearchResult"
                    },
                    {
                        "$ref": "#/components/schemas/SubjectSearchResult"
                    }
                ]
            },
            "type": "array",
            "title": "Results"
        },
        "count": {
            "type": "integer",
            "title": "Count"
        }
    },
    "type": "object",
    "required": [
        "results",
        "count"
    ],
    "title": "SearchResultsPublic",
    "description": "Global search response containing a flat list of typed results."
}

application/json

{
    "detail": [
        {
            "loc": [
                null
            ],
            "msg": "string",
            "type": "string",
            "input": null,
            "ctx": {}
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "properties": {
        "detail": {
            "items": {
                "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
        }
    },
    "type": "object",
    "title": "HTTPValidationError"
}

Schemas¶

AgeClass¶

Type: string

BaseImagePublic¶

Name	Type	Description
`image_url`	string
`shot_type_id`	string(uuid)
`shot_type_label`	string

BodyType¶

Type: string

DefaultShotTypes¶

Type: string

ExternalImagePushPublic¶

Name	Type	Description
`completed_at`
`created_at`	string(date-time)
`error_message`
`id`	string(uuid)
`integration_id`	string(uuid)
`push_status`	PushStatus
`pushed_at`
`updated_at`	string(date-time)

EyeColor¶

Type: string

Gender¶

Type: string

HairColor¶

Type: string

HTTPValidationError¶

Name	Type	Description
`detail`	Array<ValidationError>

MediaInput¶

Name	Type	Description
`alt_text`
`caption`
`color_profile`
`dominant_color`
`duration`
`height`
`media_resource_id`
`protected`	boolean
`url`
`width`

MediaResourcePublic¶

Name	Type	Description
`alt_text`
`aspect_ratio`
`caption`
`color_profile`
`content_hash`	string
`created_at`	string(date-time)
`dominant_color`
`duration`
`extension`	string
`file_size`	integer
`height`
`id`	string(uuid)
`orientation`
`protected`	boolean
`resource_type`	MediaResourceType
`url`	string
`width`

MediaResourceType¶

Type: string

OutfitGenerationStatus¶

Type: string

PosePresetPublic¶

Name	Type	Description
`created_at`	string(date-time)
`id`	string(uuid)
`name`	string
`organization_id`
`owner_id`	string(uuid)
`pose_image_media`
`pose_image_url`
`prompt`
`shot_type_id`	string(uuid)
`updated_at`	string(date-time)

ProductGender¶

Type: string

ProductPlacement¶

Type: string

ProductPublic¶

Name	Type	Description
`age_class`
`archived`	boolean
`back_description`
`back_image_media`
`back_image_url`
`brand`
`brand_collection`
`brand_metadata`
`category`
`closure_type`
`colour`
`cover_image_media`
`cover_image_url`
`created_at`	string(date-time)
`data_image_urls`	Array<string>
`demo`	boolean
`description`
`ecommerce_description`
`enabled`	boolean
`exports_completed`
`exports_total`
`fit_type`
`gender`	ProductGender
`id`	string(uuid)
`in_store_date`
`integration_name`
`is_filler`	boolean
`length_type`
`master_item_code`
`materials`
`name`	string
`neckline`
`organization_id`
`owner_id`	string(uuid)
`pattern`
`placement`
`product_family`
`product_type`
`product_type_id`
`public`	boolean
`reference_images`	Array<string>
`reference_images_media`
`season`
`shot_status`
`shot_status_shooting_look_id`
`shots`	Array<>
`sku`
`sleeve_type`
`style_code`
`theme`
`type`
`updated_at`	string(date-time)
`year`
`zone`

ProductSearchResult¶

Name	Type	Description
`data`	ProductPublic
`resource_type`	SearchResourceType

ProductShootingStatus¶

Type: string

PushStatus¶

Type: string

RevisionSource¶

Type: string

SearchResourceType¶

Type: string

SearchResultsPublic¶

Name	Type	Description
`count`	integer
`results`	Array<>

SetBaseImagePublic¶

Name	Type	Description
`created_at`	string(date-time)
`id`	string(uuid)
`image_media`
`image_url`
`shot_type_id`	string(uuid)
`subject_id`	string(uuid)
`updated_at`	string(date-time)

SetDesignPublic¶

Name	Type	Description
`background_preset_id`
`base_images`	Array<SetBaseImagePublic>
`created_at`	string(date-time)
`description`
`id`	string(uuid)
`name`	string
`organization_id`
`owner_id`	string(uuid)
`reference_images`	Array<SetReferenceImagePublic>
`subject_portraits`	Array<SubjectPortraitPublic>
`updated_at`	string(date-time)

SetReferenceImagePublic¶

Name	Type	Description
`created_at`	string(date-time)
`id`	string(uuid)
`image_media`
`image_url`
`label`
`shot_type_id`	string(uuid)
`updated_at`	string(date-time)

ShootingGuidelinesPublic¶

Name	Type	Description
`background_preset_id`
`created_at`	string(date-time)
`file_format`	string
`id`	string(uuid)
`name`	string
`organization_id`
`owner_id`	string(uuid)
`pose_presets`	Array<PosePresetPublic>
`resolution_preset_id`
`set_design`
`set_design_id`
`shot_types`	Array<ShotTypePublic>
`subjects`	Array<SubjectPublic>
`updated_at`	string(date-time)

ShootingLookOutfitPublic¶

Name	Type	Description
`created_at`	string(date-time)
`generation_error`
`generation_status`
`id`	string(uuid)
`outfit_instruction`
`outfit_product_ids`	Array<string(uuid)>
`outfit_products`	Array<ProductPublic>
`outfit_ref_images_media`
`outfit_ref_imgs_urls`	Array<string>
`retry_count`	integer
`shooting_look_id`	string(uuid)
`updated_at`	string(date-time)

ShootingLookPublic¶

Name	Type	Description
`assignee`
`assignee_id`
`background_preset_id`
`created_at`	string(date-time)
`file_format`	string
`height`
`id`	string(uuid)
`outfit`
`outfit_id`
`outfit_instruction`		Get outfit instruction from the selected outfit.
`outfit_product_ids`	Array<string(uuid)>	Get outfit product IDs from the selected outfit (supports both storage mechanisms).
`outfit_proposals`	Array<ShootingLookOutfitPublic>
`outfit_ref_imgs_urls`	Array<string>	Get outfit reference image URLs from the selected outfit.
`pose_presets`	Array<PosePresetPublic>
`product_cover_image_url`
`product_id`
`product_name`
`product_sku`
`resolution_preset_id`
`set_design`
`set_design_id`
`shooting_id`	string(uuid)
`shot_status`
`shots`	Array<ShotPublic>
`status`	ShootingLookStatus
`style_id`
`subject_id`
`subject_name`
`updated_at`	string(date-time)
`width`

ShootingLookSearchResult¶

Name	Type	Description
`data`	ShootingLookPublic
`resource_type`	SearchResourceType

ShootingLookStatus¶

Type: string

ShootingPublic¶

Name	Type	Description
`archived`	boolean
`brand`
`collection`
`created_at`	string(date-time)
`default_guidelines`
`default_guidelines_id`
`description`
`due_date`
`id`	string(uuid)
`name`	string
`organization_id`
`owner_id`	string(uuid)
`season`
`shot_status`
`status`
`updated_at`	string(date-time)

ShootingSearchResult¶

Name	Type	Description
`data`	ShootingPublic
`resource_type`	SearchResourceType

ShootingStatus¶

Type: string

ShotPublic¶

Name	Type	Description
`created_at`	string(date-time)
`current_revision_id`
`id`	string(uuid)
`pose_preset_id`
`revisions`	Array<ShotRevisionPublic>
`rework_available`	integer
`rework_used`	integer
`shooting_look_id`
`shot_type`
`status`	ShotStatus
`updated_at`	string(date-time)

ShotRevisionImagePublic¶

Name	Type	Description
`autogenerated`	boolean
`created_at`	string(date-time)
`effective_image_url`
`id`	string(uuid)
`image_media`
`image_url`
`notes`
`prediction_id`
`refine_id`
`shot_revision_id`	string(uuid)
`sketch_image_media`
`sketch_image_url`
`source_type`	RevisionSource
`updated_at`	string(date-time)

ShotRevisionPublic¶

Name	Type	Description
`created_at`	string(date-time)
`display_name`	string
`effective_image_url`
`id`	string(uuid)
`images`	Array<ShotRevisionImagePublic>
`notes`
`owner`
`owner_id`
`previous_revision_id`
`push_records`	Array<ExternalImagePushPublic>
`push_status`		Aggregate push status across all integrations. Returns: None (no pushes), PENDING, IN_PROGRESS, AWAITING_CONFIRMATION, COMPLETED, or FAILED Priority: FAILED > IN_PROGRESS > AWAITING_CONFIRMATION > PENDING > COMPLETED
`shot_id`	string(uuid)
`shot_revision_status`
`shot_status`	ShotStatus
`updated_at`	string(date-time)
`version`	integer

ShotRevisionStatus¶

Type: string

ShotStatus¶

Type: string

ShotTypeFraming¶

Type: string

ShotTypePublic¶

Name	Type	Description
`core_focus`	boolean
`created_at`	string(date-time)
`default_shot_type`
`file_naming_convention`
`framing`	ShotTypeFraming
`id`	string(uuid)
`margins`
`name`	string
`organization_id`
`owner_id`
`prompt`
`prompt_builder_section`
`public`	boolean
`reference_image`
`reference_image_url`
`shot_type_prompt_instruction`
`shot_type_ref_image_url`
`updated_at`	string(date-time)
`view_angle`	ViewAngle

SubjectAgeClass¶

Type: string

SubjectMeasurementsPublic¶

Name	Type	Description
`bust_cm`
`eye_color`
`hair_color`
`height_cm`
`hips_cm`
`id`	string(uuid)
`shoe_eu`
`waist_cm`

SubjectPortraitPublic¶

Name	Type	Description
`created_at`	string(date-time)
`id`	string(uuid)
`image_media`
`subject_id`	string(uuid)
`updated_at`	string(date-time)

SubjectPublic¶

Name	Type	Description
`age_class`	SubjectAgeClass
`base_images`	Array<BaseImagePublic>
`body_type`
`cover_image_media`
`cover_image_url`
`created_at`	string(date-time)
`data_image_urls`	Array<string>
`data_images_media`
`description`
`enabled`	boolean
`ethnicity`
`gender`	Gender
`id`	string(uuid)
`lora_status`	string
`lora_trigger`
`measurements`
`name`	string
`negative_prompt`
`organization_id`
`owner_id`	string(uuid)
`portfolio_images_media`
`portrait_image_media`
`portrait_image_url`
`positive_prompt`
`public`	boolean
`ready`	boolean
`slug`	string
`subject_type`	SubjectType
`surname`
`updated_at`	string(date-time)

SubjectSearchResult¶

Name	Type	Description
`data`	SubjectPublic
`resource_type`	SearchResourceType

SubjectType¶

Type: string

UserSummary¶

Name	Type	Description
`email`	string(email)
`full_name`
`id`	string(uuid)

ValidationError¶

Name	Type	Description
`ctx`
`input`
`loc`	Array<>
`msg`	string
`type`	string

ViewAngle¶

Type: string

Security schemes¶

Name	Type	Scheme	Description
OAuth2PasswordBearer	oauth2