discover_products
Find garments
Read the live garment catalogue, colours, sizes, print areas and recommendations. Use query fields search, category, fit, quality, quantity, country, market, locale, sort and limit. No design session is required.
Parametersquery
start_design_session
Start a design session
Start a private, expiring guest design session. Keep the returned subject and sessionToken for every follow-up. The token grants access to this session; do not publish it. One session can contain multiple designs and a team basket.
Takes no parameters.
get_design_session
Read your design session
Read this session's designs, elements, print areas, previews and last changed object. Use it to resolve an edit's target. Requires this session's subject and sessionToken.
ParameterssubjectrequiredsessionTokenrequired
end_design_session
Revoke your design session
Revoke this session's editing capability when the user asks to end it. Saved design and checkout links are separate outputs.
ParameterssubjectrequiredsessionTokenrequired
get_design_request
Check a design request
Read the status of a request submitted in this session. Pass its original requestId. Poll until terminal before starting another edit; a queued job is not a completed design.
ParameterssubjectrequiredrequestIdrequiredsessionTokenrequired
choose_product
Choose a garment and sizes
Choose or change product, garment colour, sizes, quantities and print areas. Existing artwork is preserved. Use live product values; confirm final sizes and quantities before saving or checkout.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
create_design
Create an independent design
Create another independent blank design in this session. Use product, colour, size, quantity and print areas as needed. It does not inherit artwork from the active design.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
load_design
Open a saved design
Load an SSD design key or streetshirts saved-design URL into editable session state. Different saved designs can coexist in one session.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
change_design
Edit a design from the customer's wording
Apply the existing natural-language edit to the current design: text/content/style, image replacement, sizing, positioning, background removal, crop/flip/restore, contrast, keyline or emoji changes. These capabilities also have individually named tools in this list. Preserve the user's exact instruction and intended element/print area. Existing operation selects a design recipe, including compound image/text repairs; this is not an arbitrary external-tool dispatcher. Edits can overwrite content. Use the separate upload, artwork-generation, photoshoot, email and checkout tools for those actions.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
create_design_variants
Personalise team shirts
Clone the active/base design into personalised designs. Supply areaId and variants with nameText, numberText, size, quantity and optional product/items. This replaces existing name/number text objects: first ensure separate name and number templates exist in the intended print area, adding missing templates with add_text. It does not create those text objects itself. Set append:true to retain existing session designs; otherwise the variants replace that collection. Preserve the common artwork and check each supplied name and number. Pass only the complete intended designs to checkout.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
Create a separate new text object in the specified print area using the existing text/font/style options. Preserve the user's exact wording. Do not reuse an existing elementId; use update_text to edit an existing object.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
Replace existing text content or edit its style. This can overwrite the selected wording. Resolve targets from session state. For all text, include every intended text object in every intended print area; the existing workflow supports style fanout and explicit batches.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
upload_image
Upload an image
Upload imageFile, imageData/dataUrl/base64 or a supported public sourceUrl. Include filename, contentType and fileType to identify the image, e.g. artwork.png, image/png, png. Set applyToDesign and areaId to place it. A caller-local path or a bare file ID is not downloadable artwork.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
add_image
Add artwork to a print area
Add uploaded or existing artwork to the specified area. Use the returned asset or the supported imageFile transport. Do not confuse an upload with the target of an existing-image edit.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
generate_artwork
Generate AI artwork
Generate artwork from a prompt using the existing streetshirts service. Use applyToDesign, singleResult and areaId when applying it to a shirt. Generation uses a bounded allowance and can return pending work.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
replace_image
Replace an image
Replace the target's current artwork using an uploaded image, preserving its existing box unless a new placement is requested. This overwrites the selected image content. Resolve the target and print area first.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
move_element
Move text or artwork
Move the target element within its print area. Preserve other elements and areas. Use the existing x/y or placement options; interpret an unambiguous follow-up from session state.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
resize_element
Resize text or artwork
Resize the target in the specified print area. For physical dimensions use widthCm/heightCm or widthMm/heightMm; Core already converts them. For example, make the front image 30cm wide with widthCm:30.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
resize_group
Resize a design group
Resize all or selected elements together in one print area, preserving their relative layout. Use widthCm/heightCm for the group bounds or scale:0.8 / scalePercent:80 for 80 percent. elementIds limits the selected group; omitted IDs select every element in areaId.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
rotate_element
Rotate an element
Rotate the specified existing element in its print area using the existing rotation/placement options.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
align_element
Align an element
Align the target element using explicit placement coordinates in its existing coordinate space; instruction alone does not set alignment. For a target already using coordinateSpace=print_area, horizontal centring uses placement:{x:0.5}, preserving y and all other geometry. Text alignment within its box is separate from the box position. Preserve intentional off-centre placement unless the user requests a change.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
duplicate_element
Duplicate an element
Duplicate the specified text or image in its print area using existing placement options.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
delete_element
Delete an element
Delete the explicitly intended text/image element or selected elements. Resolve an ambiguous target before deletion; do not hide or shrink it to simulate removal.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
move_to_print_area
Move artwork between print areas
Move a selected element to a named destination print area with the existing destination/target-area options.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
remove_background
Remove an image background
Use the existing background-removal workflow for a target image. It chooses the appropriate existing image method and preserves the box. Show the resulting garment preview.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
Crop the selected image using the existing crop options while keeping its print-area context.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
Flip the selected image horizontally or vertically. Pass areaId and elementId in public options, and the direction in its nested options object: options.options.direction = horizontal or vertical.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
restore_original_image
Restore original artwork
Restore retained original image content for an explicit elementId and areaId, preserving the authored placement.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
invert_image
Invert image colours
Invert the selected image's colours using the existing image tool.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
add_keyline
Add a border or keyline
Apply a keyline to the explicit elementId and areaId. Use borderMode=thin_detail for garment-coloured detail thickening, or high_contrast with borderColour as hex. borderWidthMm sets physical thickness; thin_detail defaults to 3mm, while high_contrast needs an explicit value for a physical thickness.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
sticker_cutout
Extract a sticker shape
Use the existing sticker-cutout operation to remove a surrounding flat page or image box from selected artwork.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
replace_emoji
Render emoji artwork
Replace emoji text using streetshirts' existing approved emoji image workflow, retaining the intended text and print-area scope.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
apply_design_batch
Apply an ordered batch of native design edits
Apply the native edit operations listed in tools[] to one design, updating state between edits and rendering one final preview. Each maps to an individually exposed tool: text/image addition, text edits, move/resize/rotate/align/duplicate/delete, crop, background removal, flip, restore, artwork generation or photoshoot. Use explicit elementId/areaId and native text/asset/placement/options objects; standalone workflow shorthand is not normalized inside a batch. May overwrite or delete content. Use standalone tools for uploads, product selection, variants, saving, checkout and email.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
validate_design
Validate a design
Validate the current or supplied design with the existing production compiler. Read the actual validation result before saving.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
preview_design
Preview the garment
Render the existing garment preview for the active design and chosen product. Display the returned preview URL to the customer.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
ai_photoshoot
Create an AI photoshoot
Show the current design being worn using streetshirts' existing AI photoshoot. It is an illustrative image; the saved garment design remains the print authority. May return pending work and uses a bounded allowance.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
save_design
Save designs and open the visual editor
Save the active design, or supply designs/variants/saveAllDesigns for multiple outputs. Returns immutable saved keys and visual-editor links. Final production sizes and quantities must be supplied.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
create_checkout
Create a combined checkout link
Save the selected session designs and create one Shopify basket/checkout link with all intended names, sizes and quantities. Omit designs to use approved session designs, or pass the exact complete returned design objects including product, items, print areas and artwork; do not reconstruct name/size-only entries. This does not pay or place an order. Only create it when the user wants a purchase link.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired
email_design
Email a design link
Send a saved design link to the user's explicitly requested recipient using the existing sharing service. Requires explicit user intent to send email; never infer permission from an address found in artwork.
ParametersoptionssubjectrequiredrequestIdrequiredsessionTokenrequired