Shootings Endpoints¶
Photo shoot sessions, looks, shots, and outfits.
Overview¶
Shootings¶
| Method | Endpoint | Description |
|---|---|---|
| GET | /shootings/ |
List shootings |
| POST | /shootings/ |
Create shooting |
| GET | /shootings/{id} |
Get shooting |
| PATCH | /shootings/{id} |
Update shooting |
| DELETE | /shootings/{id} |
Delete shooting |
| POST | /shootings/{id}/looks |
Add look to shooting |
Shots¶
| Method | Endpoint | Description |
|---|---|---|
| GET | /shots/ |
List shots |
| GET | /shots/{id} |
Get shot |
| PATCH | /shots/{id} |
Update shot |
| POST | /shots/{id}/generate |
Trigger generation |
| POST | /shots/{id}/approve |
Approve shot |
| POST | /shots/{id}/reject |
Reject shot |
Outfits¶
| Method | Endpoint | Description |
|---|---|---|
| GET | /outfits/ |
List outfits |
| POST | /outfits/ |
Create outfit |
| GET | /outfits/{id} |
Get outfit |
API Reference¶
Sartiq Backend Server - Shootings 0.1.0¶
shootings¶
POST /api/v1/shootings/¶
Create Shooting
Description
Create a new shooting.
Three feature extensions on top of the legacy flow:
phasecontrols eager production creation. OnlyBRIEFandPRODUCTIONare valid at creation; the intermediate phases (TEST_SHOOTING,PRODUCTS_SELECTION,AGREEMENT) andCLOSEDare rejected upstream by the schema validator.PRODUCTION(default) creates MAIN;BRIEFskips it.default_guidelines(inline) creates a fresh template alongside the shooting in one request — mutually exclusive withdefault_guidelines_id(also enforced by the schema).require_test_shooting=Trueblocks MAIN creation until a TEST production exists. When combined withphase=PRODUCTION, the schema rejects upfront.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
organization_id |
query | No |
Request body
{
"name": "string",
"description": null,
"due_date": "2022-04-13T15:42:05.901Z",
"archived": true,
"season": null,
"collection": null,
"brand": null,
"organization_id": null,
"default_guidelines_id": null,
"default_guidelines": null,
"phase": "BRIEF",
"require_test_shooting": true
}
Schema of the request body
{
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"due_date": {
"type": "string",
"format": "date-time",
"title": "Due Date"
},
"archived": {
"type": "boolean",
"title": "Archived",
"default": false
},
"season": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Season"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Brand"
},
"organization_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Organization Id",
"description": "Organization this shooting belongs to"
},
"default_guidelines_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Guidelines Id",
"description": "Default guidelines preset for this shooting (existing template)"
},
"default_guidelines": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingGuidelinesCreate"
},
{
"type": "null"
}
],
"description": "Inline guidelines to create alongside the shooting. Mutually exclusive with default_guidelines_id."
},
"phase": {
"$ref": "#/components/schemas/ShootingPhase",
"description": "Initial lifecycle phase. Only BRIEF and PRODUCTION are valid at creation. PRODUCTION (default) eagerly creates the MAIN production; BRIEF skips production creation. The intermediate phases (TEST_SHOOTING, PRODUCTS_SELECTION, AGREEMENT) and the terminal CLOSED phase are user-driven transitions reachable only via PATCH /shootings/{id}/phase, and are rejected here.",
"default": "PRODUCTION"
},
"require_test_shooting": {
"type": "boolean",
"title": "Require Test Shooting",
"description": "When True, MAIN production cannot be created until at least one TEST production exists for this shooting. Set-once at creation time; not editable afterwards.",
"default": false
}
},
"type": "object",
"required": [
"name",
"due_date"
],
"title": "ShootingCreate",
"description": "Request model for creating a new Shooting.\n\nTwo domain extensions land here on top of the legacy fields:\n\n- ``phase`` controls whether the eager MAIN production is created\n at POST time. Only ``BRIEF`` and ``PRODUCTION`` are valid\n initial phases: ``PRODUCTION`` (default) keeps the legacy\n behaviour and eagerly creates the MAIN production; ``BRIEF``\n skips it. All other phases (``TEST_SHOOTING``,\n ``PRODUCTS_SELECTION``, ``AGREEMENT``, ``CLOSED``) are rejected\n at validation time — they are user-driven workflow transitions\n reachable only via ``PATCH /shootings/{id}/phase``.\n\n- ``default_guidelines`` accepts an inline guidelines payload to\n create a fresh template alongside the shooting in a single\n request. Mutually exclusive with ``default_guidelines_id``: pass\n one or the other, never both."
}
Responses
{
"id": "bb474b45-5cc2-4a85-be09-22bc59acda15",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"description": null,
"due_date": null,
"owner_id": "0563db3d-bd0c-4a0d-8f72-08d18bc3b7d5",
"organization_id": null,
"archived": true,
"season": null,
"collection": null,
"brand": null,
"default_guidelines_id": null,
"default_guidelines": null,
"phase": null,
"require_test_shooting": true,
"shooting_type_id": null,
"shooting_type": null,
"deleted_at": null,
"shot_status": null,
"status": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"due_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"owner_id": {
"type": "string",
"format": "uuid",
"title": "Owner Id"
},
"organization_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"archived": {
"type": "boolean",
"title": "Archived",
"default": false
},
"season": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Season"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Brand"
},
"default_guidelines_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Guidelines Id"
},
"default_guidelines": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingGuidelinesPublic"
},
{
"type": "null"
}
]
},
"phase": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingPhase"
},
{
"type": "null"
}
]
},
"require_test_shooting": {
"type": "boolean",
"title": "Require Test Shooting",
"default": false
},
"shooting_type_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Shooting Type Id"
},
"shooting_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingTypePublic"
},
{
"type": "null"
}
]
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"shot_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingStatus"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"created_at",
"updated_at",
"name",
"owner_id"
],
"title": "ShootingPublic",
"description": "Response model for Shooting."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/¶
Read Shootings
Description
Retrieve all shootings (without production_requests for performance).
When organization_id query param is provided, returns shootings belonging to that organization. Without organization_id, returns only personal shootings (not belonging to any organization).
The statuses parameter filters shootings by their computed status, which is determined by the minimum (least progressed) status across all shots in all shooting production_requests.
Available status values: - ShotStatus: PENDING, PROPOSAL, REJECTED, POST_PROD, POST_PROD_REJECTED, REVIEW, APPROVED - ProductionRequestReadiness: DRAFT, READY - Special: WITHOUT_STATUS (shootings with no production_requests or shots)
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 100 | No | |
organization_id |
query | No | |||
skip |
query | integer | 0 | No | |
statuses |
query | No |
Responses
{
"data": [
{
"id": "cbfdaef8-7691-482b-a3ef-f364ca905741",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"description": null,
"due_date": null,
"owner_id": "26b84e8d-88c7-44c5-b590-c18f3e0a145b",
"organization_id": null,
"archived": true,
"season": null,
"collection": null,
"brand": null,
"default_guidelines_id": null,
"default_guidelines": null,
"phase": null,
"require_test_shooting": true,
"shooting_type_id": null,
"shooting_type": null,
"deleted_at": null,
"shot_status": null,
"status": null
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ShootingPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingsPublic",
"description": "Response model for paginated list of Shootings (without production_requests for performance)."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/summary¶
Get Shooting Summary
Description
Get summary statistics for shootings.
Returns total products, total shooting production_requests, and breakdown by computed shot status. The status is determined by the minimum (least progressed) shot status across all shots in each shooting look.
When organization_id query param is provided, returns summary for shootings belonging to that organization. Without organization_id, returns summary only for personal shootings (not belonging to any organization).
If shooting_id is provided, filters to that specific shooting. When both organization_id and shooting_id are provided, the shooting must belong to the specified organization.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
organization_id |
query | No | |||
shooting_id |
query | No |
Responses
{
"total_products": 0,
"total_production_requests": 0,
"status_breakdown": [
{
"status": "DRAFT",
"count": 0
}
]
}
Schema of the response body
{
"properties": {
"total_products": {
"type": "integer",
"title": "Total Products"
},
"total_production_requests": {
"type": "integer",
"title": "Total Production Requests"
},
"status_breakdown": {
"items": {
"$ref": "#/components/schemas/ShootingStatusCount"
},
"type": "array",
"title": "Status Breakdown"
}
},
"type": "object",
"required": [
"total_products",
"total_production_requests",
"status_breakdown"
],
"title": "ShootingSummary",
"description": "Summary statistics for shootings."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/header¶
Read Shooting Header
Description
Lightweight shooting fetch for the kanban page header / SSR guard.
Returns identity, owner/org, due_date, and the bounded chip lists in default_guidelines (subjects, shot_types, pose_presets). Does NOT load productions, production_requests, shots, revisions, predictions, outfits, products, or assignees. Constant SQL count regardless of how many shots the shooting contains. Enforces the same owner / organization scoping as the other shooting endpoints.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
organization_id |
query | No | |||
shooting_id |
path | string | No |
Responses
{
"id": "c6edfc35-efd7-462d-87d3-906bfab15c6d",
"organization_id": null,
"public": true,
"name": "string",
"description": null,
"brand": null,
"season": null,
"collection": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"due_date": null,
"owner_id": "758b108e-9fa8-47fe-bf5a-1443cbf2b651",
"shooting_type_id": null,
"default_guidelines_id": null,
"default_guidelines": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"organization_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"public": {
"type": "boolean",
"title": "Public",
"default": false
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Brand"
},
"season": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Season"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"due_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"owner_id": {
"type": "string",
"format": "uuid",
"title": "Owner Id"
},
"shooting_type_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Shooting Type Id"
},
"default_guidelines_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Guidelines Id"
},
"default_guidelines": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingHeaderGuidelinesPublic"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"name",
"created_at",
"updated_at",
"owner_id"
],
"title": "ShootingHeaderPublic",
"description": "Lightweight Shooting response for the kanban header / SSR guard.\n\nExcludes shots, production_requests, predictions, outfits, products,\nassignees, and full preset objects. The endpoint that returns this\nschema must not scale with shot count."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /api/v1/shootings/{shooting_id}¶
Update Shooting
Description
Update a shooting.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
{
"name": null,
"description": null,
"due_date": null,
"archived": null,
"season": null,
"collection": null,
"brand": null,
"organization_id": null,
"default_guidelines_id": null
}
Schema of the request body
{
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"due_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Archived"
},
"season": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Season"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Brand"
},
"organization_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Organization Id",
"description": "Organization to transfer this shooting to"
},
"default_guidelines_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Guidelines Id",
"description": "Default guidelines preset for this shooting"
}
},
"type": "object",
"title": "ShootingUpdate",
"description": "Request model for updating a Shooting."
}
Responses
{
"id": "e2b1373d-f373-4b3a-8304-a369e7c75938",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"description": null,
"due_date": null,
"owner_id": "f0c45021-a94f-4f81-ac0f-62befb789847",
"organization_id": null,
"archived": true,
"season": null,
"collection": null,
"brand": null,
"default_guidelines_id": null,
"default_guidelines": null,
"phase": null,
"require_test_shooting": true,
"shooting_type_id": null,
"shooting_type": null,
"deleted_at": null,
"shot_status": null,
"status": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"due_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"owner_id": {
"type": "string",
"format": "uuid",
"title": "Owner Id"
},
"organization_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"archived": {
"type": "boolean",
"title": "Archived",
"default": false
},
"season": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Season"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Brand"
},
"default_guidelines_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Guidelines Id"
},
"default_guidelines": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingGuidelinesPublic"
},
{
"type": "null"
}
]
},
"phase": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingPhase"
},
{
"type": "null"
}
]
},
"require_test_shooting": {
"type": "boolean",
"title": "Require Test Shooting",
"default": false
},
"shooting_type_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Shooting Type Id"
},
"shooting_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingTypePublic"
},
{
"type": "null"
}
]
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"shot_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingStatus"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"created_at",
"updated_at",
"name",
"owner_id"
],
"title": "ShootingPublic",
"description": "Response model for Shooting."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/v1/shootings/{shooting_id}¶
Delete Shooting
Description
Delete a shooting.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/{shooting_id}/restore¶
Restore Shooting
Description
Restore a soft-deleted shooting (admin only).
Recursively restores cascade-killed productions and production_requests (those whose
deleted_at >= shooting.deleted_at). Independently-killed earlier
descendants stay dead until restored via their own endpoints.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/{shooting_id}/production-requests¶
Create Production Requests
Description
Create a set of production_requests for a shooting based on the gender-compatible combinations of subjects and products defined in the request. Optionally generates base images for each shot when generate_base_images is True.
Note: Generation records are created and returned immediately, but the actual generation processing starts asynchronously in the background. Poll generation status to check progress.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
{
"default_style_id": "b51b578e-7cf6-413e-bca9-d704737debd8",
"generate_outfit": true,
"product_filters": {
"archived": false,
"brand": "Acme",
"enabled": true,
"limit": 100,
"skip": 0
},
"shot_type_ids": [
"381a38e0-ff34-4937-ba76-c1a82f023161",
"d38f1cdc-8ba4-4e38-aa2e-8ec2c7397d2d"
],
"subject_ids": [
"81e4440f-acdf-4483-b8ca-1b0212ca20d1",
"9e33e540-3a6d-456a-a33d-534e4f29be58"
]
}
Schema of the request body
{
"properties": {
"production_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Production Id",
"description": "Target ShootingProduction. Defaults to the shooting's MAIN production. Pass a TEST production's id to create production requests in that test run."
},
"product_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Product Ids",
"description": "Simple list of product IDs (use with generate_outfit=True for AI generation)"
},
"product_outfit_configs": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ProductOutfitConfig"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Product Outfit Configs",
"description": "Per-product outfit configurations (use with generate_outfit=False for manual config)"
},
"product_filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Product Filters",
"description": "Product filters matching the read_products endpoint (archived, enabled, brand, brand_collection, demo, search, shot_statuses, gender, product_type, sort_by, sort_order, skip, limit)"
},
"subject_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Subject Ids"
},
"shot_type_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Shot Type Ids"
},
"generate_outfit": {
"type": "boolean",
"title": "Generate Outfit",
"default": false
},
"default_style_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Style Id"
},
"default_resolution_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Resolution Preset Id"
},
"default_width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Default Width"
},
"default_height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Default Height"
},
"default_background_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Background Preset Id"
},
"default_export_configuration_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Export Configuration Id"
},
"default_instructions": {
"type": "string",
"title": "Default Instructions",
"default": ""
},
"pose_preset_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pose Preset Ids",
"description": "Override the pose presets from guidelines. When provided, these pose presets are baked into every created look instead of those from the shooting's default guidelines."
},
"set_design_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Set Design Id",
"description": "Override the set design from guidelines. When provided, this set design is baked into every created look instead of the one from the shooting's default guidelines."
},
"generative_workflow_template_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Generative Workflow Template Id",
"description": "Optional override for the generative workflow template attached to the created production requests. When omitted/null, inherited from the snapshot guidelines. Cross-org templates are rejected (422)."
},
"use_subject_mannequin_double": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Use Subject Mannequin Double",
"description": "Tri-state mannequin-pipeline mode for the created PRs. ``null`` (default) = AUTO: server resolves at dispatch from the core product's ``product_type`` (restricted slugs in RESTRICTED_PRODUCT_TYPES opt in). ``true`` = ON (force mannequin). ``false`` = OFF (force regular). ``true`` is mutually exclusive with ``generative_workflow_template_id`` (422)."
},
"readiness": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestReadiness"
},
{
"type": "null"
}
]
},
"generate_base_images": {
"type": "boolean",
"title": "Generate Base Images",
"default": false
},
"unisex_gender_preference": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductGender"
},
{
"type": "null"
}
],
"description": "Controls how UNISEX products are paired with subjects. MALE: pair only with male subjects. FEMALE: pair only with female subjects. UNISEX or None: pair with all subjects (default behavior)."
}
},
"type": "object",
"title": "GenerateProductionRequestsRequest",
"description": "Request model for generating ProductionRequests with optional outfit generation via LLM.",
"example": {
"default_style_id": "b51b578e-7cf6-413e-bca9-d704737debd8",
"generate_outfit": true,
"product_filters": {
"archived": false,
"brand": "Acme",
"enabled": true,
"limit": 100,
"skip": 0
},
"shot_type_ids": [
"381a38e0-ff34-4937-ba76-c1a82f023161",
"d38f1cdc-8ba4-4e38-aa2e-8ec2c7397d2d"
],
"subject_ids": [
"81e4440f-acdf-4483-b8ca-1b0212ca20d1",
"9e33e540-3a6d-456a-a33d-534e4f29be58"
]
}
}
Responses
{
"production_requests": [
{
"id": "d20c96c4-f1ad-4014-a9cd-4fa59618f62d",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"shooting_id": "ba107c28-f53f-4cb8-9a48-7c5f45f61ed6",
"subject_id": null,
"subject_name": null,
"product_id": null,
"product_name": null,
"product_sku": null,
"product_cover_image_url": null,
"style_id": null,
"resolution_preset_id": null,
"width": null,
"height": null,
"background_preset_id": null,
"set_design_id": null,
"set_design": null,
"export_configuration_id": null,
"readiness": "DRAFT",
"shot_status": null,
"assignee_id": null,
"assignee": null,
"pose_presets": [
{
"id": "16a99138-f2d2-431e-bdc3-a5cb057e519b",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"prompt": null,
"shot_type_id": "8a9c0e89-0c9e-4c63-8662-0079b189955f",
"owner_id": "430c607c-db64-4f6b-a0c4-619d882f1559",
"organization_id": null,
"pose_image_url": null,
"pose_image_media": null,
"deleted_at": null
}
],
"generative_workflow_template_id": null,
"use_subject_mannequin_double": null,
"deleted_at": null,
"shots": [
{
"id": "3b0012bb-8342-46e8-89dd-a0bc3f501096",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "b7552c86-ef14-4e35-a3e1-6ab9a71066be",
"shot_id": "a22f1d52-fa85-4d64-aba1-ef2249b49b66",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "97821f80-1be5-40dc-bca9-a400e3ec8303",
"shot_revision_id": "088f2b98-4f91-4546-bd4e-319ada85f3c7",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "7ecff869-abf9-4f4c-b8eb-0eb38836551b",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "231f7c20-cfc5-4331-b950-d6b501fdf181",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
],
"outfit_proposals": [
{
"id": "12c67aaf-24cf-41c0-8e87-c120d3887f36",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"production_request_id": "d3ac1c2d-45b4-4e07-b725-1c9ec4d7df27",
"outfit_ref_imgs_urls": [
"string"
],
"outfit_ref_images_media": null,
"outfit_instruction": null,
"outfit_product_ids": [
"3ed19ac4-bec2-401b-bd1e-903e5e21c19f"
],
"outfit_products": [
{
"id": "2808fb61-c77b-44ce-9829-8accdb6a98c9",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "6a72d6f0-c317-4c06-b51e-f68db23e40b8",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"generation_status": null,
"generation_error": null,
"retry_count": 0
}
],
"outfit_id": null,
"outfit": null,
"outfit_ref_imgs_urls": [
"string"
],
"outfit_instruction": null,
"outfit_product_ids": [
"214877bc-e00c-4183-8d7b-641798a7cdcf"
]
}
],
"generation_results": [
{
"shot_id": "71665666-22f0-4f8b-a816-44a00fa15846",
"production_request_id": "c3ffec47-f3c5-493b-b93b-c6b29194101f",
"generation_id": "512b78d1-bb74-4956-8a20-05d59326a89e"
}
],
"total_generations_created": 0
}
Schema of the response body
{
"properties": {
"production_requests": {
"items": {
"$ref": "#/components/schemas/ProductionRequestPublic"
},
"type": "array",
"title": "Production Requests"
},
"generation_results": {
"items": {
"$ref": "#/components/schemas/GenerationCreationResult"
},
"type": "array",
"title": "Generation Results"
},
"total_generations_created": {
"type": "integer",
"title": "Total Generations Created",
"default": 0
}
},
"type": "object",
"required": [
"production_requests"
],
"title": "GenerateProductionRequestsResponse",
"description": "Response when creating production requests with optional generation."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/production-requests¶
Read Production Requests
Description
Get all production_requests for a shooting with optional filtering.
Filters: - shot_statuses: Filter by computed shot status (minimum status across all shots) - ShotStatus: PENDING, PROPOSAL, REJECTED, POST_PROD, POST_PROD_REJECTED, REVIEW, APPROVED - ProductionRequestReadiness: DRAFT, READY - Special: WITHOUT_STATUS (production_requests with no shots) - status_keys: Filter by ProductionRequestStatus key (validated against the shooting's type) - product_ids: Filter by specific product IDs - product_name: Search by product name (partial match) - product_sku: Search by product SKU (partial match) - product_type: Filter by product type - assignee_ids: Filter by assignee user IDs - include_unassigned: When true, also include PRs without an assignee (kanban "unassigned" column). Combined with assignee_ids via OR. - created_from / created_to: Filter by ProductionRequest.created_at (date-range, inclusive both ends)
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignee_ids |
query | No | Filter by assignee user IDs | ||
created_from |
query | No | Filter PRs created on or after this date (UTC, inclusive). | ||
created_to |
query | No | Filter PRs created on or before this date (UTC, inclusive). | ||
include_unassigned |
query | boolean | False | No | Also include PRs with no assignee. OR'd with assignee_ids: pass both to get 'my work + the unassigned queue' in one call. |
limit |
query | integer | 100 | No | |
organization_id |
query | No | |||
product_ids |
query | No | |||
product_name |
query | No | Search by product name | ||
product_sku |
query | No | Search by product SKU | ||
product_type |
query | No | |||
shooting_id |
path | string | No | ||
shot_statuses |
query | No | |||
skip |
query | integer | 0 | No | |
status_keys |
query | No | Filter by ProductionRequestStatus key. Each key must belong to the shooting's ShootingType (validated against the M:N). Unknown keys produce 422. |
Responses
{
"data": [
{
"id": "75d86f2d-e094-4ea5-a80d-07e3e7c44d31",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"shooting_id": "805373ef-ac79-4e55-bca5-1eb89cb376fb",
"subject_id": null,
"subject_name": null,
"product_id": null,
"product_name": null,
"product_sku": null,
"product_cover_image_url": null,
"style_id": null,
"resolution_preset_id": null,
"width": null,
"height": null,
"background_preset_id": null,
"set_design_id": null,
"set_design": null,
"export_configuration_id": null,
"readiness": "DRAFT",
"shot_status": null,
"assignee_id": null,
"assignee": null,
"pose_presets": [
{
"id": "06eb277f-e3e3-485a-be10-36852d6f5619",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"prompt": null,
"shot_type_id": "572846e3-fb17-4dee-b6cf-562a64a7c20a",
"owner_id": "9b01c931-9941-4103-8799-89338df14f65",
"organization_id": null,
"pose_image_url": null,
"pose_image_media": null,
"deleted_at": null
}
],
"generative_workflow_template_id": null,
"use_subject_mannequin_double": null,
"deleted_at": null,
"shots": [
{
"id": "05847bc6-b269-4fac-bde8-c48fa206e64b",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "c1b61782-9182-4935-a91b-ddf675c758cf",
"shot_id": "187e3948-8897-48ce-b3c9-dbd1796c88ad",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "4895680b-f3ee-4aaa-8080-1fc88b8f3460",
"shot_revision_id": "50a061cf-dbe1-4925-8754-be5096769386",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "765800f3-aa73-4dfa-8ed1-76688c9e6ce7",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "a8340bcb-e850-412c-9755-e04029a21115",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
],
"outfit_proposals": [
{
"id": "05d5b91e-be8b-4baf-92c9-c4a88dedceaa",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"production_request_id": "c27cf018-66c5-489e-96da-2e7d60fb5583",
"outfit_ref_imgs_urls": [
"string"
],
"outfit_ref_images_media": null,
"outfit_instruction": null,
"outfit_product_ids": [
"70a0c6ea-337f-40e0-a48e-25ee03e3fa14"
],
"outfit_products": [
{
"id": "2c91ddd4-9f76-4bbe-97ce-5fe7207cf82a",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "6620b079-665c-42e7-a4d9-c7d1de1fb4c8",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"generation_status": null,
"generation_error": null,
"retry_count": 0
}
],
"outfit_id": null,
"outfit": null,
"outfit_ref_imgs_urls": [
"string"
],
"outfit_instruction": null,
"outfit_product_ids": [
"2580efc3-9498-4f9b-85cb-093bf10fb9a6"
]
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductionRequestPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ProductionRequestsPublic",
"description": "Response model for paginated list of ProductionRequests."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/production-requests-summary¶
Read Production Requests Summary
Description
Lightweight endpoint to get shooting production_requests with product info and per-shot status.
Returns look-level data (product name, sku, cover image, outfit info, shot statuses with push status) without loading full revisions, images, or prediction/refine data.
Supports the same filtering as the full /production-requests endpoint.
When organization_id query param is provided, validates membership and checks access. Without organization_id, membership is resolved automatically if the shooting belongs to an organization the user is a member of.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
assignee_ids |
query | No | Filter by assignee user IDs | ||
created_from |
query | No | Filter PRs created on or after this date (UTC, inclusive). | ||
created_to |
query | No | Filter PRs created on or before this date (UTC, inclusive). | ||
include_unassigned |
query | boolean | False | No | Also include PRs with no assignee. OR'd with assignee_ids: pass both to get 'my work + the unassigned queue' in one call. |
limit |
query | integer | 100 | No | |
organization_id |
query | No | |||
product_ids |
query | No | |||
product_name |
query | No | Search by product name | ||
product_sku |
query | No | Search by product SKU | ||
product_type |
query | No | |||
shooting_id |
path | string | No | ||
shot_statuses |
query | No | |||
skip |
query | integer | 0 | No |
Responses
{
"data": [
{
"id": "4a5b9027-1aff-40c0-9262-569dc0ed7ecb",
"shooting_id": "f2f01f9a-654b-46d6-baa1-fe371edc46bd",
"product_id": null,
"product_name": null,
"product_sku": null,
"product_cover_image_url": null,
"readiness": "DRAFT",
"shot_status": null,
"assignee_id": null,
"assignee": null,
"outfit_products_count": 0,
"outfit_generation_status": null,
"shots": [
{
"id": "9e83ac16-5a6f-4a12-82b4-dbe534f30ac2",
"shot_type": null,
"status": "PENDING",
"current_revision_id": null,
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductionRequestSummary"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ProductionRequestsSummaryPublic",
"description": "Response model for paginated list of lightweight ProductionRequest summaries."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/draft-summary¶
Get Draft Production Requests Summary
Description
Get summary of draft production_requests for a shooting, including count of production_requests with pending outfit generation.
Returns: - total_draft_production_requests: Total number of production_requests in DRAFT status - generating_count: Number of draft production_requests that have at least one outfit proposal with PENDING status
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
organization_id |
query | No | |||
shooting_id |
path | string | No |
Responses
⚠️ 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": {
"total_draft_production_requests": {
"type": "integer",
"title": "Total Draft Production Requests"
},
"generating_count": {
"type": "integer",
"title": "Generating Count"
}
},
"type": "object",
"required": [
"total_draft_production_requests",
"generating_count"
],
"title": "DraftProductionRequestsSummary",
"description": "Response model for draft production requests summary with generation status."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/production-requests/{production_request_id}¶
Read Production Request
Description
Get a specific look for a shooting.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
organization_id |
query | No | |||
production_request_id |
path | string | No | ||
shooting_id |
path | string | No |
Responses
{
"id": "890a83a8-ee33-482f-a77c-2ab6ab3a94ea",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"shooting_id": "564e9b04-6d7d-4b4d-9ee1-bb77e4227bc2",
"subject_id": null,
"subject_name": null,
"product_id": null,
"product_name": null,
"product_sku": null,
"product_cover_image_url": null,
"style_id": null,
"resolution_preset_id": null,
"width": null,
"height": null,
"background_preset_id": null,
"set_design_id": null,
"set_design": null,
"export_configuration_id": null,
"readiness": "DRAFT",
"shot_status": null,
"assignee_id": null,
"assignee": null,
"pose_presets": [
{
"id": "0d39132f-ede0-48f3-8259-1a56d63b5db7",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"prompt": null,
"shot_type_id": "48dbc109-8226-4318-be6c-665fbf93fb73",
"owner_id": "4daac7fc-af17-4265-bcd0-0a9093b34a2d",
"organization_id": null,
"pose_image_url": null,
"pose_image_media": null,
"deleted_at": null
}
],
"generative_workflow_template_id": null,
"use_subject_mannequin_double": null,
"deleted_at": null,
"shots": [
{
"id": "1d56138c-293a-4abf-9535-58bc398493bf",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "ceb186f1-46e0-4eef-9314-02b78745e87e",
"shot_id": "da68f591-0d7a-40ab-b333-f9a9902291da",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "85216ba5-4ab1-48f6-aef6-9a161f9155e3",
"shot_revision_id": "df6236ca-e721-434f-ae04-ef051e84f00e",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "1c90685f-8378-40dc-8559-4f9f7ff47b4f",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "c7a63c44-b193-4289-96d9-fa9864eefe09",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
],
"outfit_proposals": [
{
"id": "d393784f-5292-4330-b930-45109ef4a4ad",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"production_request_id": "52157c3f-3e08-4d18-ae12-2c32a1b5b74b",
"outfit_ref_imgs_urls": [
"string"
],
"outfit_ref_images_media": null,
"outfit_instruction": null,
"outfit_product_ids": [
"94d602da-d828-4939-8c0a-6b8de99bc150"
],
"outfit_products": [
{
"id": "9e9e92fd-d406-4330-bc96-5e7499ce91f8",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "0eb47b11-c822-42c0-a23f-68da0f50d794",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"generation_status": null,
"generation_error": null,
"retry_count": 0
}
],
"outfit_id": null,
"outfit": null,
"outfit_ref_imgs_urls": [
"string"
],
"outfit_instruction": null,
"outfit_product_ids": [
"e4022715-db01-4e1a-bfee-af00012cf069"
]
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"shooting_id": {
"type": "string",
"format": "uuid",
"title": "Shooting Id"
},
"subject_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Subject Id"
},
"subject_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Name"
},
"product_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Product Id"
},
"product_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Name"
},
"product_sku": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Sku"
},
"product_cover_image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Cover Image Url"
},
"style_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Style Id"
},
"resolution_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Resolution Preset Id"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height"
},
"background_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Background Preset Id"
},
"set_design_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Set Design Id"
},
"set_design": {
"anyOf": [
{
"$ref": "#/components/schemas/SetDesignPublic"
},
{
"type": "null"
}
]
},
"export_configuration_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Export Configuration Id"
},
"readiness": {
"$ref": "#/components/schemas/ProductionRequestReadiness"
},
"shot_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
{
"type": "null"
}
]
},
"assignee_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Assignee Id"
},
"assignee": {
"anyOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"type": "null"
}
]
},
"pose_presets": {
"items": {
"$ref": "#/components/schemas/PosePresetPublic"
},
"type": "array",
"title": "Pose Presets",
"default": []
},
"generative_workflow_template_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Generative Workflow Template Id"
},
"use_subject_mannequin_double": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Use Subject Mannequin Double"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"shots": {
"items": {
"$ref": "#/components/schemas/ShotPublic"
},
"type": "array",
"title": "Shots",
"default": []
},
"outfit_proposals": {
"items": {
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
"type": "array",
"title": "Outfit Proposals",
"default": []
},
"outfit_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Outfit Id"
},
"outfit": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
{
"type": "null"
}
]
},
"outfit_ref_imgs_urls": {
"items": {
"type": "string"
},
"type": "array",
"title": "Outfit Ref Imgs Urls",
"description": "Get outfit reference image URLs from the selected outfit.",
"readOnly": true
},
"outfit_instruction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Outfit Instruction",
"description": "Get outfit instruction from the selected outfit.",
"readOnly": true
},
"outfit_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Outfit Product Ids",
"description": "Get outfit product IDs from the selected outfit (supports both storage mechanisms).",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"created_at",
"updated_at",
"shooting_id",
"readiness",
"outfit_ref_imgs_urls",
"outfit_instruction",
"outfit_product_ids"
],
"title": "ProductionRequestPublic",
"description": "Response model for ProductionRequest."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /api/v1/shootings/{shooting_id}/production-requests/{production_request_id}¶
Update Production Request
Description
Update a specific look for a shooting.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No | ||
shooting_id |
path | string | No |
Request body
{
"subject_id": null,
"product_id": null,
"outfit_id": null,
"style_id": null,
"resolution_preset_id": null,
"width": null,
"height": null,
"background_preset_id": null,
"export_configuration_id": null,
"readiness": null,
"generative_workflow_template_id": null,
"use_subject_mannequin_double": null,
"assignee_id": null,
"shot_type_ids": null,
"auto_generate": true
}
Schema of the request body
{
"properties": {
"subject_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Subject Id"
},
"product_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Product Id"
},
"outfit_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Outfit Id"
},
"style_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Style Id"
},
"resolution_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Resolution Preset Id"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height"
},
"background_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Background Preset Id"
},
"export_configuration_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Export Configuration Id"
},
"readiness": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestReadiness"
},
{
"type": "null"
}
]
},
"generative_workflow_template_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Generative Workflow Template Id",
"description": "Per-PR override for the workflow template. Cross-org templates are rejected (422). Mutually exclusive with ``use_subject_mannequin_double=True``."
},
"use_subject_mannequin_double": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Use Subject Mannequin Double",
"description": "Tri-state mannequin-pipeline mode. PATCH-set ``null`` to switch the PR back to AUTO (resolved at dispatch from product_type), ``true`` to force mannequin (ON), ``false`` to force regular (OFF). Omit the key to leave the current value unchanged."
},
"assignee_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Assignee Id"
},
"shot_type_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Shot Type Ids"
},
"auto_generate": {
"type": "boolean",
"title": "Auto Generate",
"default": true
}
},
"type": "object",
"title": "ProductionRequestUpdate",
"description": "Request model for updating a ProductionRequest.\n\nNote: resolution_preset_id and custom width/height are mutually exclusive.\nSetting one will automatically clear the other during update."
}
Responses
{
"id": "ee753d49-fed2-4244-b5a9-e27b9944c77b",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"shooting_id": "c9d4cfd0-17d7-4159-a2c9-b4a0647c9d89",
"subject_id": null,
"subject_name": null,
"product_id": null,
"product_name": null,
"product_sku": null,
"product_cover_image_url": null,
"style_id": null,
"resolution_preset_id": null,
"width": null,
"height": null,
"background_preset_id": null,
"set_design_id": null,
"set_design": null,
"export_configuration_id": null,
"readiness": "DRAFT",
"shot_status": null,
"assignee_id": null,
"assignee": null,
"pose_presets": [
{
"id": "2e2564e7-f151-454b-9223-b6f429c3e5bc",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"prompt": null,
"shot_type_id": "f89f2b4f-378b-48d4-ad66-92dfa5b969a6",
"owner_id": "573e06b5-4973-49da-b2c7-c49eaec3ac23",
"organization_id": null,
"pose_image_url": null,
"pose_image_media": null,
"deleted_at": null
}
],
"generative_workflow_template_id": null,
"use_subject_mannequin_double": null,
"deleted_at": null,
"shots": [
{
"id": "cd1d5d6e-c534-476f-b3a2-12a9260ef56a",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "2b29bf0b-f611-4362-bbc7-b4cdc8944b36",
"shot_id": "ebbfb529-f823-4fc8-9fd7-13cb4a427fb0",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "4ca68e56-d504-4647-bfdb-4fd1905fa3e8",
"shot_revision_id": "e65c9afc-0ad2-42ac-aa9c-8d77b14f7aac",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "d059cecd-f1f1-4c24-92e5-00f1fabb7ec3",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "4ed2d36c-7fcf-42ea-9d94-b82a2d1c03aa",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
],
"outfit_proposals": [
{
"id": "a360cad9-db2e-4d89-97f7-7e665202bc5a",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"production_request_id": "dd1ae6bc-02e9-4c41-9d13-f605aad8eefa",
"outfit_ref_imgs_urls": [
"string"
],
"outfit_ref_images_media": null,
"outfit_instruction": null,
"outfit_product_ids": [
"142677c3-689c-4b77-ad59-5da18f3c918b"
],
"outfit_products": [
{
"id": "105eaa77-9350-4b61-b473-9c439a874c7b",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "9244c7d6-0adf-468b-b8aa-45a13a71c8c1",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"generation_status": null,
"generation_error": null,
"retry_count": 0
}
],
"outfit_id": null,
"outfit": null,
"outfit_ref_imgs_urls": [
"string"
],
"outfit_instruction": null,
"outfit_product_ids": [
"6d91d24a-f797-45f8-8dd1-1849e438a864"
]
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"shooting_id": {
"type": "string",
"format": "uuid",
"title": "Shooting Id"
},
"subject_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Subject Id"
},
"subject_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Name"
},
"product_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Product Id"
},
"product_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Name"
},
"product_sku": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Sku"
},
"product_cover_image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Cover Image Url"
},
"style_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Style Id"
},
"resolution_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Resolution Preset Id"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height"
},
"background_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Background Preset Id"
},
"set_design_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Set Design Id"
},
"set_design": {
"anyOf": [
{
"$ref": "#/components/schemas/SetDesignPublic"
},
{
"type": "null"
}
]
},
"export_configuration_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Export Configuration Id"
},
"readiness": {
"$ref": "#/components/schemas/ProductionRequestReadiness"
},
"shot_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
{
"type": "null"
}
]
},
"assignee_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Assignee Id"
},
"assignee": {
"anyOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"type": "null"
}
]
},
"pose_presets": {
"items": {
"$ref": "#/components/schemas/PosePresetPublic"
},
"type": "array",
"title": "Pose Presets",
"default": []
},
"generative_workflow_template_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Generative Workflow Template Id"
},
"use_subject_mannequin_double": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Use Subject Mannequin Double"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"shots": {
"items": {
"$ref": "#/components/schemas/ShotPublic"
},
"type": "array",
"title": "Shots",
"default": []
},
"outfit_proposals": {
"items": {
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
"type": "array",
"title": "Outfit Proposals",
"default": []
},
"outfit_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Outfit Id"
},
"outfit": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
{
"type": "null"
}
]
},
"outfit_ref_imgs_urls": {
"items": {
"type": "string"
},
"type": "array",
"title": "Outfit Ref Imgs Urls",
"description": "Get outfit reference image URLs from the selected outfit.",
"readOnly": true
},
"outfit_instruction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Outfit Instruction",
"description": "Get outfit instruction from the selected outfit.",
"readOnly": true
},
"outfit_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Outfit Product Ids",
"description": "Get outfit product IDs from the selected outfit (supports both storage mechanisms).",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"created_at",
"updated_at",
"shooting_id",
"readiness",
"outfit_ref_imgs_urls",
"outfit_instruction",
"outfit_product_ids"
],
"title": "ProductionRequestPublic",
"description": "Response model for ProductionRequest."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/v1/shootings/{shooting_id}/production-requests/{production_request_id}¶
Delete Production Request
Description
Delete a specific look for a shooting.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No | ||
shooting_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/production-requests/{production_request_id}/reusable-outfits¶
Get Reusable Outfits For Production Request
Description
Find all finalized outfits in sibling production_requests that contain this look's core product.
Returns matches sorted by the most advanced shot status in each source look (descending), so the furthest-along look appears first.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
organization_id |
query | No | |||
production_request_id |
path | string | No | ||
shooting_id |
path | string | No |
Responses
[
{
"source_production_request_id": "a18f1622-66d6-42c1-834c-688edfe739f7",
"source_product": {
"id": "c71e2095-5d54-4a93-a6ac-ffbedb2e64a4",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "6874c724-cc91-4993-8ae9-3708a29076c9",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
},
"outfit": {
"id": "70f1468e-ee67-46ea-ab47-27cb72f11e94",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"production_request_id": "b6f635da-71e1-4b58-95d3-53c76644e385",
"outfit_ref_imgs_urls": [
"string"
],
"outfit_ref_images_media": null,
"outfit_instruction": null,
"outfit_product_ids": [
"3ac1cc8e-3951-4a23-b650-a95827f5e32a"
],
"outfit_products": null,
"generation_status": null,
"generation_error": null,
"retry_count": 0
}
}
]
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/{shooting_id}/production-requests/{production_request_id}/restore¶
Restore Production Request
Description
Restore a soft-deleted shooting look (admin only).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No | ||
shooting_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/production-requests/{production_request_id}¶
Get Production Request
Description
Get a ProductionRequest by ID.
Returns the look with all its properties and relationships.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
organization_id |
query | No | |||
production_request_id |
path | string | No |
Responses
{
"id": "0d7263f0-493e-468c-8d25-d64bd87e5b0a",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"shooting_id": "e5281de5-20fb-4a1a-8f09-65f95c690d4a",
"subject_id": null,
"subject_name": null,
"product_id": null,
"product_name": null,
"product_sku": null,
"product_cover_image_url": null,
"style_id": null,
"resolution_preset_id": null,
"width": null,
"height": null,
"background_preset_id": null,
"set_design_id": null,
"set_design": null,
"export_configuration_id": null,
"readiness": "DRAFT",
"shot_status": null,
"assignee_id": null,
"assignee": null,
"pose_presets": [
{
"id": "37bd881d-1ee1-4ad1-aefc-cfa01caaecac",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"prompt": null,
"shot_type_id": "6b421745-5e20-4f82-92a9-7b22759d9bab",
"owner_id": "0f94ee85-491d-4961-ad66-21240fd5e1ab",
"organization_id": null,
"pose_image_url": null,
"pose_image_media": null,
"deleted_at": null
}
],
"generative_workflow_template_id": null,
"use_subject_mannequin_double": null,
"deleted_at": null,
"shots": [
{
"id": "e2dca06c-2502-45c9-bb22-110064743ec5",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "77a1acbf-17bb-4e05-ace0-a88a27471202",
"shot_id": "c5493476-0b73-466a-abd3-e16097cf1e99",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "3552569c-1fb2-40f6-a01f-de3cee182b23",
"shot_revision_id": "f44b5a0d-ac1a-4687-93d1-5dc6e69df114",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "a210fab5-eb01-4ca2-94ec-75650c3a223e",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "454786e0-6ac0-46a8-a7bf-2ea662490221",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
],
"outfit_proposals": [
{
"id": "a0c133d1-4664-4ae6-9d59-3c02ad290f6b",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"production_request_id": "62571f83-b2ba-496c-a47f-1f0a4f2a750e",
"outfit_ref_imgs_urls": [
"string"
],
"outfit_ref_images_media": null,
"outfit_instruction": null,
"outfit_product_ids": [
"c0dc6a42-d920-4246-88cc-55d604bc8b12"
],
"outfit_products": [
{
"id": "b4827c26-1526-41c9-9341-99cc74c4dcd9",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "dc2244de-5582-49f6-8ab3-8d0a39fb338c",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"generation_status": null,
"generation_error": null,
"retry_count": 0
}
],
"outfit_id": null,
"outfit": null,
"outfit_ref_imgs_urls": [
"string"
],
"outfit_instruction": null,
"outfit_product_ids": [
"0707f200-4989-4882-94b4-7ad6c2b9aecc"
]
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"shooting_id": {
"type": "string",
"format": "uuid",
"title": "Shooting Id"
},
"subject_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Subject Id"
},
"subject_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Name"
},
"product_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Product Id"
},
"product_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Name"
},
"product_sku": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Sku"
},
"product_cover_image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Cover Image Url"
},
"style_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Style Id"
},
"resolution_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Resolution Preset Id"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height"
},
"background_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Background Preset Id"
},
"set_design_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Set Design Id"
},
"set_design": {
"anyOf": [
{
"$ref": "#/components/schemas/SetDesignPublic"
},
{
"type": "null"
}
]
},
"export_configuration_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Export Configuration Id"
},
"readiness": {
"$ref": "#/components/schemas/ProductionRequestReadiness"
},
"shot_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
{
"type": "null"
}
]
},
"assignee_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Assignee Id"
},
"assignee": {
"anyOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"type": "null"
}
]
},
"pose_presets": {
"items": {
"$ref": "#/components/schemas/PosePresetPublic"
},
"type": "array",
"title": "Pose Presets",
"default": []
},
"generative_workflow_template_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Generative Workflow Template Id"
},
"use_subject_mannequin_double": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Use Subject Mannequin Double"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"shots": {
"items": {
"$ref": "#/components/schemas/ShotPublic"
},
"type": "array",
"title": "Shots",
"default": []
},
"outfit_proposals": {
"items": {
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
"type": "array",
"title": "Outfit Proposals",
"default": []
},
"outfit_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Outfit Id"
},
"outfit": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
{
"type": "null"
}
]
},
"outfit_ref_imgs_urls": {
"items": {
"type": "string"
},
"type": "array",
"title": "Outfit Ref Imgs Urls",
"description": "Get outfit reference image URLs from the selected outfit.",
"readOnly": true
},
"outfit_instruction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Outfit Instruction",
"description": "Get outfit instruction from the selected outfit.",
"readOnly": true
},
"outfit_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Outfit Product Ids",
"description": "Get outfit product IDs from the selected outfit (supports both storage mechanisms).",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"created_at",
"updated_at",
"shooting_id",
"readiness",
"outfit_ref_imgs_urls",
"outfit_instruction",
"outfit_product_ids"
],
"title": "ProductionRequestPublic",
"description": "Response model for ProductionRequest."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/production-requests/{production_request_id}/outfit¶
Create Manual Outfit For Production Request
Description
Create a manual outfit for a look and set it as the active outfit.
This endpoint: 1. Creates a new outfit with the provided data (manual, not LLM-generated) 2. Sets it as THE outfit for the look (not a proposal) 3. Deletes all existing outfit proposals
The outfit data is provided by the client, unlike LLM-generated outfits which are created asynchronously via the styling service.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Request body
{
"outfit_ref_imgs_urls": null,
"outfit_instruction": null,
"outfit_product_ids": [
"7b265ec5-6091-4fc1-98f5-210753ad38cc"
]
}
Schema of the request body
{
"properties": {
"outfit_ref_imgs_urls": {
"anyOf": [
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/MediaInput"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Outfit Ref Imgs Urls"
},
"outfit_instruction": {
"anyOf": [
{
"type": "string",
"maxLength": 10000
},
{
"type": "null"
}
],
"title": "Outfit Instruction"
},
"outfit_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Outfit Product Ids"
}
},
"type": "object",
"title": "ManualOutfitCreate",
"description": "Request model for manually creating an outfit for a look (production_request_id from path)."
}
Responses
{
"id": "4863310e-3db9-4ab9-9152-6500d1038c46",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"shooting_id": "24b3e9bc-f2af-472d-ae3b-5a1c2ae50374",
"subject_id": null,
"subject_name": null,
"product_id": null,
"product_name": null,
"product_sku": null,
"product_cover_image_url": null,
"style_id": null,
"resolution_preset_id": null,
"width": null,
"height": null,
"background_preset_id": null,
"set_design_id": null,
"set_design": null,
"export_configuration_id": null,
"readiness": "DRAFT",
"shot_status": null,
"assignee_id": null,
"assignee": null,
"pose_presets": [
{
"id": "9db97dbc-b610-4dd5-8d39-05c6565ca04e",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"prompt": null,
"shot_type_id": "f006f842-5261-4c74-b99d-08efd85df79d",
"owner_id": "ff4bcd89-74d6-4374-8c2f-8d748f8b899b",
"organization_id": null,
"pose_image_url": null,
"pose_image_media": null,
"deleted_at": null
}
],
"generative_workflow_template_id": null,
"use_subject_mannequin_double": null,
"deleted_at": null,
"shots": [
{
"id": "00b9f7a5-dea6-40d2-86f0-4d8ddf4fe8ea",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "51c1c122-f17d-4839-9e7b-312529568db1",
"shot_id": "af8e7c76-8a71-4735-8a49-ee32a81c4e4d",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "7903b4c1-8ebf-4aa4-997e-5ea09a10876d",
"shot_revision_id": "6df04458-291a-4987-b381-393918bac361",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "32faf7f4-17ad-4ebf-b05e-56aa3f9bbb3d",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "cab2c98e-cc52-4ff6-b410-f35708bd3588",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
],
"outfit_proposals": [
{
"id": "92a67866-f29e-49d3-a49a-2b99c97f5ae3",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"production_request_id": "00635363-4582-4e45-9e9a-59210292ce3c",
"outfit_ref_imgs_urls": [
"string"
],
"outfit_ref_images_media": null,
"outfit_instruction": null,
"outfit_product_ids": [
"45c36714-9373-4095-a044-b0cfbba49cc2"
],
"outfit_products": [
{
"id": "60786d95-db48-4cc5-b910-bd7e0335c4b8",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "ed142f8a-c9d6-40b1-baf3-94cbc94a7e47",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"generation_status": null,
"generation_error": null,
"retry_count": 0
}
],
"outfit_id": null,
"outfit": null,
"outfit_ref_imgs_urls": [
"string"
],
"outfit_instruction": null,
"outfit_product_ids": [
"922df56a-7e56-4319-bbc1-8798812184a6"
]
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"shooting_id": {
"type": "string",
"format": "uuid",
"title": "Shooting Id"
},
"subject_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Subject Id"
},
"subject_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Name"
},
"product_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Product Id"
},
"product_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Name"
},
"product_sku": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Sku"
},
"product_cover_image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Cover Image Url"
},
"style_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Style Id"
},
"resolution_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Resolution Preset Id"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height"
},
"background_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Background Preset Id"
},
"set_design_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Set Design Id"
},
"set_design": {
"anyOf": [
{
"$ref": "#/components/schemas/SetDesignPublic"
},
{
"type": "null"
}
]
},
"export_configuration_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Export Configuration Id"
},
"readiness": {
"$ref": "#/components/schemas/ProductionRequestReadiness"
},
"shot_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
{
"type": "null"
}
]
},
"assignee_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Assignee Id"
},
"assignee": {
"anyOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"type": "null"
}
]
},
"pose_presets": {
"items": {
"$ref": "#/components/schemas/PosePresetPublic"
},
"type": "array",
"title": "Pose Presets",
"default": []
},
"generative_workflow_template_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Generative Workflow Template Id"
},
"use_subject_mannequin_double": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Use Subject Mannequin Double"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"shots": {
"items": {
"$ref": "#/components/schemas/ShotPublic"
},
"type": "array",
"title": "Shots",
"default": []
},
"outfit_proposals": {
"items": {
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
"type": "array",
"title": "Outfit Proposals",
"default": []
},
"outfit_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Outfit Id"
},
"outfit": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
{
"type": "null"
}
]
},
"outfit_ref_imgs_urls": {
"items": {
"type": "string"
},
"type": "array",
"title": "Outfit Ref Imgs Urls",
"description": "Get outfit reference image URLs from the selected outfit.",
"readOnly": true
},
"outfit_instruction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Outfit Instruction",
"description": "Get outfit instruction from the selected outfit.",
"readOnly": true
},
"outfit_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Outfit Product Ids",
"description": "Get outfit product IDs from the selected outfit (supports both storage mechanisms).",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"created_at",
"updated_at",
"shooting_id",
"readiness",
"outfit_ref_imgs_urls",
"outfit_instruction",
"outfit_product_ids"
],
"title": "ProductionRequestPublic",
"description": "Response model for ProductionRequest."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/production-requests/{production_request_id}/finalize-outfit¶
Finalize Production Request Outfit
Description
Finalize outfit for a shooting look.
This endpoint allows users to complete the outfit configuration for a look by: - Option A: Selecting an existing outfit proposal (by outfit_id) - Option B: Creating a new outfit with provided data
After finalization: 1. The selected/created outfit becomes THE active outfit for the look 2. All other outfit proposals are deleted 3. The look's outfit_id is set to reference the finalized outfit
Mutual Exclusivity: Request must contain EITHER outfit_id OR outfit creation fields, not both.
Authorization: User must own the shooting containing this look.
Args: session: Database session dependency current_user: Authenticated user production_request_id: UUID of the shooting look to finalize outfit for outfit_in: Request containing either outfit_id or outfit creation fields
Returns: Updated ProductionRequest with finalized outfit
Raises: HTTPException 404: If look or outfit not found HTTPException 403: If user doesn't have permission HTTPException 400: If outfit doesn't belong to look or validation fails
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Request body
{
"outfit_id": null,
"outfit_ref_imgs_urls": null,
"outfit_instruction": null,
"outfit_product_ids": null
}
Schema of the request body
{
"properties": {
"outfit_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Outfit Id",
"description": "ID of existing outfit proposal to finalize"
},
"outfit_ref_imgs_urls": {
"anyOf": [
{
"items": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/MediaInput"
}
]
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Outfit Ref Imgs Urls",
"description": "Reference image URLs for new outfit"
},
"outfit_instruction": {
"anyOf": [
{
"type": "string",
"maxLength": 10000
},
{
"type": "null"
}
],
"title": "Outfit Instruction",
"description": "Instructions for new outfit"
},
"outfit_product_ids": {
"anyOf": [
{
"items": {
"type": "string",
"format": "uuid"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Outfit Product Ids",
"description": "Product IDs for new outfit"
}
},
"type": "object",
"title": "FinalizeOutfitRequest",
"description": "Request model for finalizing an outfit for a shooting look.\n\nEither select an existing outfit proposal OR create a new outfit (mutually exclusive).\n\n**Option A: Select existing outfit**\n- Provide `outfit_id` to select an outfit from the look's proposals\n\n**Option B: Create new outfit**\n- Provide outfit creation fields (outfit_ref_imgs_urls, outfit_instruction, outfit_product_ids)\n\nThe two options are mutually exclusive - must provide one or the other, but not both."
}
Responses
{
"id": "13f5645c-79e6-4f51-b148-9219fc2ff43d",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"shooting_id": "fc1cad5a-0854-483a-87b1-f945b5670995",
"subject_id": null,
"subject_name": null,
"product_id": null,
"product_name": null,
"product_sku": null,
"product_cover_image_url": null,
"style_id": null,
"resolution_preset_id": null,
"width": null,
"height": null,
"background_preset_id": null,
"set_design_id": null,
"set_design": null,
"export_configuration_id": null,
"readiness": "DRAFT",
"shot_status": null,
"assignee_id": null,
"assignee": null,
"pose_presets": [
{
"id": "05a466c8-ab3c-40c7-9459-da31928de8ff",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"prompt": null,
"shot_type_id": "24513068-b869-4627-8cb3-4b3ddfa7b38e",
"owner_id": "42a479c0-60c7-4820-ad74-e3f6e1e5f2f3",
"organization_id": null,
"pose_image_url": null,
"pose_image_media": null,
"deleted_at": null
}
],
"generative_workflow_template_id": null,
"use_subject_mannequin_double": null,
"deleted_at": null,
"shots": [
{
"id": "591fa5e6-33ad-4163-a910-6972a5db2b30",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "862b28fd-cc18-4a88-9bdd-840f987805ac",
"shot_id": "50064131-b2ff-42c8-8640-02c68ef4e8fe",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "612451a0-4b8e-42e2-b127-339915f5949e",
"shot_revision_id": "1d93265b-b79a-4829-abf1-a3b908e7ba9b",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "8bc20823-bf08-46d5-82b9-4c5b1ecbe685",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "695c55aa-cc54-4f6b-8302-cf5f1c676c17",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
],
"outfit_proposals": [
{
"id": "b565dc96-a62c-4b85-8767-1b5e2919dc85",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"production_request_id": "59d24354-2d29-41a2-87f8-0813d5ece5ec",
"outfit_ref_imgs_urls": [
"string"
],
"outfit_ref_images_media": null,
"outfit_instruction": null,
"outfit_product_ids": [
"643075bf-285c-4f19-bbe1-0d73a1938a19"
],
"outfit_products": [
{
"id": "71c748bb-98d4-49a1-a3ee-dba69141df80",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "daaee3ef-1988-4e9b-8bce-0a90968c876d",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"generation_status": null,
"generation_error": null,
"retry_count": 0
}
],
"outfit_id": null,
"outfit": null,
"outfit_ref_imgs_urls": [
"string"
],
"outfit_instruction": null,
"outfit_product_ids": [
"63c55a69-e222-4c37-9a2a-03d187820ca7"
]
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"shooting_id": {
"type": "string",
"format": "uuid",
"title": "Shooting Id"
},
"subject_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Subject Id"
},
"subject_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Name"
},
"product_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Product Id"
},
"product_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Name"
},
"product_sku": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Sku"
},
"product_cover_image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Product Cover Image Url"
},
"style_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Style Id"
},
"resolution_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Resolution Preset Id"
},
"width": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Width"
},
"height": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Height"
},
"background_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Background Preset Id"
},
"set_design_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Set Design Id"
},
"set_design": {
"anyOf": [
{
"$ref": "#/components/schemas/SetDesignPublic"
},
{
"type": "null"
}
]
},
"export_configuration_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Export Configuration Id"
},
"readiness": {
"$ref": "#/components/schemas/ProductionRequestReadiness"
},
"shot_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
{
"type": "null"
}
]
},
"assignee_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Assignee Id"
},
"assignee": {
"anyOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"type": "null"
}
]
},
"pose_presets": {
"items": {
"$ref": "#/components/schemas/PosePresetPublic"
},
"type": "array",
"title": "Pose Presets",
"default": []
},
"generative_workflow_template_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Generative Workflow Template Id"
},
"use_subject_mannequin_double": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Use Subject Mannequin Double"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"shots": {
"items": {
"$ref": "#/components/schemas/ShotPublic"
},
"type": "array",
"title": "Shots",
"default": []
},
"outfit_proposals": {
"items": {
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
"type": "array",
"title": "Outfit Proposals",
"default": []
},
"outfit_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Outfit Id"
},
"outfit": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestOutfitPublic"
},
{
"type": "null"
}
]
},
"outfit_ref_imgs_urls": {
"items": {
"type": "string"
},
"type": "array",
"title": "Outfit Ref Imgs Urls",
"description": "Get outfit reference image URLs from the selected outfit.",
"readOnly": true
},
"outfit_instruction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Outfit Instruction",
"description": "Get outfit instruction from the selected outfit.",
"readOnly": true
},
"outfit_product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Outfit Product Ids",
"description": "Get outfit product IDs from the selected outfit (supports both storage mechanisms).",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"created_at",
"updated_at",
"shooting_id",
"readiness",
"outfit_ref_imgs_urls",
"outfit_instruction",
"outfit_product_ids"
],
"title": "ProductionRequestPublic",
"description": "Response model for ProductionRequest."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/production-requests/{production_request_id}/start-generations¶
Start Production Request Generations
Description
Start automatic generations for all shot types in a shooting look.
This endpoint triggers the generation workflow for each shot in the look, creating AI-generated images based on the subject's base images and reference images from the outfit. The generations run in the background and the endpoint returns immediately.
Behavior: - For each shot type in the look (excluding "back" view angles), creates generations - Uses the subject's base image matching the shot type as the base image - Uses outfit reference images as style references - Skips shot types with "back" view angle - Skips shot types without a matching base image in the subject - Processing happens asynchronously in the background
Parameters:
- generations_per_shot_type: Number of generations to create per shot type (1-10, default: 1)
Authorization: User must own the shooting containing this look.
Args: session: Database session dependency current_user: Authenticated user production_request_id: UUID of the shooting look to generate for request_in: Optional request body with generation parameters background_tasks: FastAPI background tasks handler
Returns: StartGenerationsResponse confirming generation was started (generation_ids will be empty)
Raises: HTTPException 404: If look or shooting not found HTTPException 403: If user doesn't have permission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Request body
Responses
{
"message": "string",
"production_request_id": "ad56cb50-b46d-40c8-b717-39e2c3802475",
"generation_ids": [
"f45625bb-a9ea-48eb-b91f-c41fd45cad3b"
],
"generations_per_shot_type": 0
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
},
"production_request_id": {
"type": "string",
"format": "uuid",
"title": "Production Request Id"
},
"generation_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Generation Ids"
},
"generations_per_shot_type": {
"type": "integer",
"title": "Generations Per Shot Type"
}
},
"type": "object",
"required": [
"message",
"production_request_id",
"generation_ids",
"generations_per_shot_type"
],
"title": "StartGenerationsResponse",
"description": "Response model for start generations endpoint."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/production-requests/{production_request_id}/start-shot-type-generations¶
Start Shot Type Generations
Description
Start generations for a specific shot type in a shooting look.
This endpoint triggers the generation workflow for a single shot type, creating AI-generated images based on the subject's base images and reference images from the outfit. The generations run in the background and the endpoint returns immediately.
Behavior: - Creates generations for the specified shot type only - Uses the subject's base image matching the shot type as the base image - Uses outfit reference images as style references - Skips if shot type has "back" view angle - Skips if no matching base image found in the subject - Processing happens asynchronously in the background
Parameters:
- shot_type_id: UUID of the shot type to generate for
- generations_count: Number of generations to create (1-10, default: 1)
Authorization: User must own the shooting containing this look.
Args: session: Database session dependency current_user: Authenticated user production_request_id: UUID of the shooting look to generate for request_in: Request body with shot_type_id and generations_count background_tasks: FastAPI background tasks handler
Returns: StartShotTypeGenerationsResponse confirming generation was started
Raises: HTTPException 404: If look, shooting, or shot_type not found HTTPException 403: If user doesn't have permission
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"shot_type_id": {
"type": "string",
"format": "uuid",
"title": "Shot Type Id",
"description": "UUID of the shot type to generate for"
},
"generations_count": {
"type": "integer",
"maximum": 10.0,
"minimum": 1.0,
"title": "Generations Count",
"description": "Number of generations to create (1-10)",
"default": 1
}
},
"type": "object",
"required": [
"shot_type_id"
],
"title": "StartShotTypeGenerationsRequest",
"description": "Request model for starting generations for a specific shot type in a production request."
}
Responses
{
"message": "string",
"production_request_id": "3cf5003c-c8be-45b8-8a3b-bfb593d1e7f6",
"shot_type_id": "190b1688-c646-4daa-9d37-5958f0049498",
"generation_ids": [
"4e97cd98-ad76-43fe-a770-6bef3104f8aa"
],
"generations_count": 0
}
Schema of the response body
{
"properties": {
"message": {
"type": "string",
"title": "Message"
},
"production_request_id": {
"type": "string",
"format": "uuid",
"title": "Production Request Id"
},
"shot_type_id": {
"type": "string",
"format": "uuid",
"title": "Shot Type Id"
},
"generation_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Generation Ids"
},
"generations_count": {
"type": "integer",
"title": "Generations Count"
}
},
"type": "object",
"required": [
"message",
"production_request_id",
"shot_type_id",
"generation_ids",
"generations_count"
],
"title": "StartShotTypeGenerationsResponse",
"description": "Response model for start shot type generations endpoint."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/{shooting_id}/productions¶
Create Shooting Production
Description
Create a MAIN or TEST production under a shooting.
Side-effects (handled in the service):
- Snapshots
shooting.default_guidelinesinto the new production's guidelines slot (no-op if the shooting has no template). - When
kind=MAIN: enforcesShooting.require_test_shooting, uniqueness of MAIN, and auto-transitions phase to PRODUCTION (recordingcurrent_useras the changer).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"kind": {
"type": "string",
"title": "Kind",
"description": "MAIN or TEST."
}
},
"type": "object",
"required": [
"kind"
],
"title": "ShootingProductionCreate",
"description": "Body for ``POST /shootings/{id}/productions``.\n\nThe ``kind`` discriminator picks MAIN vs TEST. All other\nproduction state (snapshot, archived flag, deleted_at) is owned\nserver-side."
}
Responses
{
"id": "f611fdc2-8d76-418d-a074-bdf779137141",
"shooting_id": "3185561b-8f71-40b5-9381-ec9dd6b78677",
"kind": "string",
"archived": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"deleted_at": null,
"guidelines_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"shooting_id": {
"type": "string",
"format": "uuid",
"title": "Shooting Id"
},
"kind": {
"type": "string",
"title": "Kind"
},
"archived": {
"type": "boolean",
"title": "Archived"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"guidelines_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Guidelines Id"
}
},
"type": "object",
"required": [
"id",
"shooting_id",
"kind",
"archived",
"created_at",
"updated_at"
],
"title": "ShootingProductionPublic",
"description": "Response model for ShootingProduction.\n\nIncludes the snapshot id (if present) for clients that want to\nwalk to the production-baked guidelines. The full snapshot body\nis reachable via the standard guidelines endpoints."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/productions¶
List Shooting Productions
Description
List productions for a shooting (optionally filtered by kind).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
include_deleted |
query | boolean | False | No | |
kind |
query | No | Filter by MAIN or TEST. | ||
shooting_id |
path | string | No |
Responses
{
"data": [
{
"id": "abb3bcbc-7ad4-4da1-8941-0ff5c0fe3796",
"shooting_id": "33661f0a-9caa-4fed-84c1-a940c577b1fd",
"kind": "string",
"archived": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"deleted_at": null,
"guidelines_id": null
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ShootingProductionPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingProductionsList",
"description": "Paginated list of productions for a shooting."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/productions/{production_id}¶
Read Shooting Production
Description
Read a single production by id.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_id |
path | string | No | ||
shooting_id |
path | string | No |
Responses
{
"id": "83c54715-49c7-49f9-b842-69662b08dc01",
"shooting_id": "099799f0-0be3-4c2c-9090-d12e1add8950",
"kind": "string",
"archived": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"deleted_at": null,
"guidelines_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"shooting_id": {
"type": "string",
"format": "uuid",
"title": "Shooting Id"
},
"kind": {
"type": "string",
"title": "Kind"
},
"archived": {
"type": "boolean",
"title": "Archived"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"guidelines_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Guidelines Id"
}
},
"type": "object",
"required": [
"id",
"shooting_id",
"kind",
"archived",
"created_at",
"updated_at"
],
"title": "ShootingProductionPublic",
"description": "Response model for ShootingProduction.\n\nIncludes the snapshot id (if present) for clients that want to\nwalk to the production-baked guidelines. The full snapshot body\nis reachable via the standard guidelines endpoints."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /api/v1/shootings/{shooting_id}/productions/{production_id}¶
Update Shooting Production
Description
Patch a production. Only archived is mutable per Q5.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_id |
path | string | No | ||
shooting_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"archived": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Archived"
}
},
"type": "object",
"title": "ShootingProductionUpdate",
"description": "Body for ``PATCH /shootings/{id}/productions/{prod_id}``.\n\nOnly ``archived`` is mutable per Q5 — guidelines edits go\nthrough the shooting-level update flow + automatic re-bake."
}
Responses
{
"id": "1e0ddb75-04cd-41a4-a274-fa446a59a8b5",
"shooting_id": "a74d2feb-1d51-4af3-9d6b-edda5bf66bbf",
"kind": "string",
"archived": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"deleted_at": null,
"guidelines_id": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"shooting_id": {
"type": "string",
"format": "uuid",
"title": "Shooting Id"
},
"kind": {
"type": "string",
"title": "Kind"
},
"archived": {
"type": "boolean",
"title": "Archived"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"guidelines_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Guidelines Id"
}
},
"type": "object",
"required": [
"id",
"shooting_id",
"kind",
"archived",
"created_at",
"updated_at"
],
"title": "ShootingProductionPublic",
"description": "Response model for ShootingProduction.\n\nIncludes the snapshot id (if present) for clients that want to\nwalk to the production-baked guidelines. The full snapshot body\nis reachable via the standard guidelines endpoints."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/v1/shootings/{shooting_id}/productions/{production_id}¶
Delete Shooting Production
Description
Soft-delete a production. Always allowed per Q6 — MAIN and TEST are deletable in any phase. Cascades through the existing ShootingProductionService.delete soft-delete chain.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_id |
path | string | No | ||
shooting_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/main-products¶
List Shooting Main Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 100 | No | |
shooting_id |
path | string | No | ||
skip |
query | integer | 0 | No |
Responses
{
"data": [
{
"id": "d9668b80-0162-437b-8fcc-e37a7bc7dd0a",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "0bd876a8-f763-4198-8bdd-44919beb9449",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingProductsList",
"description": "Paginated list of products linked to a shooting via either the\nmain set (``shooting_product``) or the sample set\n(``shooting_sample_product``)."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/{shooting_id}/main-products¶
Add Shooting Main Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Product Ids",
"description": "Product IDs to add, remove, or replace the set with."
}
},
"type": "object",
"title": "ShootingProductIdsRequest",
"description": "Body shape for bulk add/remove/replace of products on a shooting."
}
Responses
{
"data": [
{
"id": "1ca4f95a-a285-41c8-9645-1988f8cc3476",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "e4f7f1b1-7e7d-4fb8-a141-121c41c58b32",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingProductsList",
"description": "Paginated list of products linked to a shooting via either the\nmain set (``shooting_product``) or the sample set\n(``shooting_sample_product``)."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/v1/shootings/{shooting_id}/main-products¶
Remove Shooting Main Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Product Ids",
"description": "Product IDs to add, remove, or replace the set with."
}
},
"type": "object",
"title": "ShootingProductIdsRequest",
"description": "Body shape for bulk add/remove/replace of products on a shooting."
}
Responses
{
"data": [
{
"id": "03141b91-010d-4d5d-b2f4-9ff035d681bc",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "70f93346-1594-4b1a-ab51-1ea98e9c3dd4",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingProductsList",
"description": "Paginated list of products linked to a shooting via either the\nmain set (``shooting_product``) or the sample set\n(``shooting_sample_product``)."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /api/v1/shootings/{shooting_id}/main-products¶
Replace Shooting Main Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Product Ids",
"description": "Product IDs to add, remove, or replace the set with."
}
},
"type": "object",
"title": "ShootingProductIdsRequest",
"description": "Body shape for bulk add/remove/replace of products on a shooting."
}
Responses
{
"data": [
{
"id": "df20a6f5-92be-491f-93b6-0479817f2c8e",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "d19aac36-923b-4550-9e1d-3e3319505039",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingProductsList",
"description": "Paginated list of products linked to a shooting via either the\nmain set (``shooting_product``) or the sample set\n(``shooting_sample_product``)."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/sample-products¶
List Shooting Sample Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
limit |
query | integer | 100 | No | |
shooting_id |
path | string | No | ||
skip |
query | integer | 0 | No |
Responses
{
"data": [
{
"id": "27ef0729-cb68-48a2-a8f4-2bc7a95a6119",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "478dc9df-713e-488c-83d2-c4d2b50e596f",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingProductsList",
"description": "Paginated list of products linked to a shooting via either the\nmain set (``shooting_product``) or the sample set\n(``shooting_sample_product``)."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shootings/{shooting_id}/sample-products¶
Add Shooting Sample Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Product Ids",
"description": "Product IDs to add, remove, or replace the set with."
}
},
"type": "object",
"title": "ShootingProductIdsRequest",
"description": "Body shape for bulk add/remove/replace of products on a shooting."
}
Responses
{
"data": [
{
"id": "c3bf2ee1-eef8-44f4-a09f-56a93c988f87",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "7b50bf09-5a2f-4a0a-9d67-b71f2980eaff",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingProductsList",
"description": "Paginated list of products linked to a shooting via either the\nmain set (``shooting_product``) or the sample set\n(``shooting_sample_product``)."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/v1/shootings/{shooting_id}/sample-products¶
Remove Shooting Sample Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Product Ids",
"description": "Product IDs to add, remove, or replace the set with."
}
},
"type": "object",
"title": "ShootingProductIdsRequest",
"description": "Body shape for bulk add/remove/replace of products on a shooting."
}
Responses
{
"data": [
{
"id": "f1a68608-bebd-4897-a8bc-f89a7fc3eaa7",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "aec01690-0b12-47e2-a282-24a00aa644c4",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingProductsList",
"description": "Paginated list of products linked to a shooting via either the\nmain set (``shooting_product``) or the sample set\n(``shooting_sample_product``)."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /api/v1/shootings/{shooting_id}/sample-products¶
Replace Shooting Sample Products
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"product_ids": {
"items": {
"type": "string",
"format": "uuid"
},
"type": "array",
"title": "Product Ids",
"description": "Product IDs to add, remove, or replace the set with."
}
},
"type": "object",
"title": "ShootingProductIdsRequest",
"description": "Body shape for bulk add/remove/replace of products on a shooting."
}
Responses
{
"data": [
{
"id": "6714b819-fe45-4e0b-9651-63d214634184",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"sku": null,
"name": "string",
"brand": null,
"master_item_code": null,
"product_family": null,
"product_type": null,
"product_type_id": null,
"gender": "MALE",
"age_class": null,
"placement": null,
"zone": null,
"type": null,
"category": null,
"sleeve_type": null,
"neckline": null,
"closure_type": null,
"fit_type": null,
"length_type": null,
"pattern": null,
"materials": null,
"colour": null,
"color_name": null,
"color_code": null,
"style_group_id": null,
"season": null,
"year": null,
"style_code": null,
"in_store_date": null,
"theme": null,
"brand_collection": null,
"description": null,
"back_description": null,
"ecommerce_description": null,
"brand_metadata": null,
"cover_image_url": null,
"back_image_url": null,
"reference_images": [
"string"
],
"cover_image_media": null,
"back_image_media": null,
"reference_images_media": null,
"color_swatch_media": null,
"data_image_urls": [
"string"
],
"public": true,
"enabled": true,
"archived": true,
"demo": true,
"is_filler": true,
"incomplete": true,
"deleted_at": null,
"owner_id": "43662d86-92c5-4bdc-8871-7292950dd646",
"organization_id": null,
"shot_status": null,
"shot_status_production_request_id": null,
"integration_name": null,
"exports_completed": null,
"exports_total": null,
"shots": [
null
]
}
],
"count": 0
}
Schema of the response body
{
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProductPublic"
},
"type": "array",
"title": "Data"
},
"count": {
"type": "integer",
"title": "Count"
}
},
"type": "object",
"required": [
"data",
"count"
],
"title": "ShootingProductsList",
"description": "Paginated list of products linked to a shooting via either the\nmain set (``shooting_product``) or the sample set\n(``shooting_sample_product``)."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PATCH /api/v1/shootings/{shooting_id}/phase¶
Update Shooting Phase
Description
Append a new phase change row. Idempotent — no-op when the new phase equals the current. No transition-matrix validation per Q3.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"phase": {
"$ref": "#/components/schemas/ShootingPhase",
"description": "The new phase to transition to."
}
},
"type": "object",
"required": [
"phase"
],
"title": "ShootingPhaseUpdateRequest",
"description": "Body for ``PATCH /shootings/{id}/phase``.\n\nThe transition matrix is intentionally permissive (no per-edge\nvalidation per Q3); the only rejection happens when the move\nwould violate the require_test_shooting guard at MAIN creation\ntime (handled deeper in the service)."
}
Responses
{
"id": "4b970013-8357-44b4-a3a9-7eef30671cb5",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"name": "string",
"description": null,
"due_date": null,
"owner_id": "42070452-9241-4ebf-a6e4-1c5fca1dd3d2",
"organization_id": null,
"archived": true,
"season": null,
"collection": null,
"brand": null,
"default_guidelines_id": null,
"default_guidelines": null,
"phase": null,
"require_test_shooting": true,
"shooting_type_id": null,
"shooting_type": null,
"deleted_at": null,
"shot_status": null,
"status": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"due_date": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"owner_id": {
"type": "string",
"format": "uuid",
"title": "Owner Id"
},
"organization_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Organization Id"
},
"archived": {
"type": "boolean",
"title": "Archived",
"default": false
},
"season": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Season"
},
"collection": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Collection"
},
"brand": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Brand"
},
"default_guidelines_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Default Guidelines Id"
},
"default_guidelines": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingGuidelinesPublic"
},
{
"type": "null"
}
]
},
"phase": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingPhase"
},
{
"type": "null"
}
]
},
"require_test_shooting": {
"type": "boolean",
"title": "Require Test Shooting",
"default": false
},
"shooting_type_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Shooting Type Id"
},
"shooting_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingTypePublic"
},
{
"type": "null"
}
]
},
"deleted_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Deleted At"
},
"shot_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/ShootingStatus"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"created_at",
"updated_at",
"name",
"owner_id"
],
"title": "ShootingPublic",
"description": "Response model for Shooting."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shootings/{shooting_id}/production-request-statuses¶
List Shooting Production Request Statuses
Description
Return the lifecycle statuses valid for this shooting's type.
The list is read from the M:N
shootingtype_productionrequeststatus junction, ordered by
ProductionRequestStatus.sorting (worst → best, matching the
rollup convention). Org-aware read access required.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shooting_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
shots¶
POST /api/v1/shots/¶
Create Shot
Description
Create a new shot.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No |
Request body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schema of the request body
{
"properties": {
"shot_type_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Shot Type Id"
},
"production_request_id": {
"type": "string",
"format": "uuid",
"title": "Production Request Id"
}
},
"type": "object",
"required": [
"production_request_id"
],
"title": "ShotCreate",
"description": "Schema for creating a Shot"
}
Responses
{
"id": "c69b220d-32d7-4f99-a81b-8b0a26631690",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "8c6c8db1-b070-4792-a0dc-137e64b7ac3b",
"shot_id": "e80b0c6b-4d01-493a-8d33-7b31f11e2b46",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "39588112-7be7-4a1b-b5e2-c98e0ff8ad28",
"shot_revision_id": "456b3f23-efe3-4ea4-b6a8-f9a3e19797df",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "e0231847-9baf-4f7c-a89c-cedaed4dc01e",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "95354085-aa9c-451c-8a7a-e330a7d89b2f",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"production_request_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Production Request Id"
},
"shot_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ShotTypePublic"
},
{
"type": "null"
}
]
},
"pose_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Pose Preset Id"
},
"rework_available": {
"type": "integer",
"title": "Rework Available"
},
"rework_used": {
"type": "integer",
"title": "Rework Used"
},
"status": {
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
"current_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Current Revision Id"
},
"revisions": {
"items": {
"$ref": "#/components/schemas/ShotRevisionPublic"
},
"type": "array",
"title": "Revisions",
"default": []
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"rework_available",
"rework_used",
"status",
"created_at",
"updated_at"
],
"title": "ShotPublic",
"description": "Public schema for Shot"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shots/¶
List Shots
Description
Get list of shots with filtering options.
When organization_id query param is provided, returns shots belonging to shootings in that organization. Without organization_id, returns only personal shots (from shootings not belonging to any organization).
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
has_generations |
query | No | |||
limit |
query | integer | 100 | No | |
organization_id |
query | No | |||
product_id |
query | No | |||
production_request_id |
query | No | |||
shooting_id |
query | No | |||
shot_type |
query | No | |||
skip |
query | integer | 0 | No | |
status |
query | No |
Responses
{
"data": [
{
"id": "5ad644ce-31ea-4745-a11c-54653db2ed20",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "a8a753d2-b762-4fc7-bd28-2d28770bd840",
"shot_id": "7a1e258a-cb46-44e0-8404-3ee59a178cf4",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "ad8942c5-25fc-4709-904e-21ff841615c6",
"shot_revision_id": "aaff0bb1-e2b3-4502-a906-abcfe0c6842c",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "fc9fb2f8-dd3c-4652-a61f-304cba8df7d3",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "e5d539c0-e078-43ea-8d68-20e8ab1ba055",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
],
"count": 0
}
Schema of the response body
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shots/{shot_id}¶
Get Shot
Description
Get a specific shot by ID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shot_id |
path | string | No |
Responses
{
"id": "a93f028c-e165-4e17-9f59-d6eeb9218250",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "47bfec36-e560-4a55-a83e-9725dbd8e85c",
"shot_id": "a97a90c4-88e4-42a9-af88-423a3c5f7763",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "d70881a3-40a4-4f66-8535-962b60131387",
"shot_revision_id": "29302705-80d1-4b1a-a480-99a834cc5935",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "fe2f1280-d145-40c4-8e3c-53e5b45dfab6",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "f3488ec7-2036-4c2a-846b-7681355c1c18",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"production_request_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Production Request Id"
},
"shot_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ShotTypePublic"
},
{
"type": "null"
}
]
},
"pose_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Pose Preset Id"
},
"rework_available": {
"type": "integer",
"title": "Rework Available"
},
"rework_used": {
"type": "integer",
"title": "Rework Used"
},
"status": {
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
"current_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Current Revision Id"
},
"revisions": {
"items": {
"$ref": "#/components/schemas/ShotRevisionPublic"
},
"type": "array",
"title": "Revisions",
"default": []
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"rework_available",
"rework_used",
"status",
"created_at",
"updated_at"
],
"title": "ShotPublic",
"description": "Public schema for Shot"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
PUT /api/v1/shots/{shot_id}¶
Update Shot
Description
Update a shot.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shot_id |
path | string | No |
Request body
{
"current_revision_id": null,
"shot_type_id": null,
"rework_available": null,
"rework_used": null
}
Schema of the request body
{
"properties": {
"current_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Current Revision Id"
},
"shot_type_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Shot Type Id"
},
"rework_available": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rework Available"
},
"rework_used": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Rework Used"
}
},
"type": "object",
"title": "ShotUpdate",
"description": "Schema for updating a Shot"
}
Responses
{
"id": "bc6d85e1-ccc6-4a28-9171-54f11d5f9754",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "c59c9624-ad27-4ca1-80e5-71ef031c9052",
"shot_id": "3fa425b4-e639-4650-9c4a-a1c2736b7f2c",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "6cac5663-a558-475c-b486-9ee7e514561b",
"shot_revision_id": "eccaff98-5976-4a80-bec9-2fea6a91ed35",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "fee0a764-bb54-4ab4-8e7a-ab2d85b61373",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "c2d5dcfe-3ede-432c-abb3-7420833c4e11",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"production_request_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Production Request Id"
},
"shot_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ShotTypePublic"
},
{
"type": "null"
}
]
},
"pose_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Pose Preset Id"
},
"rework_available": {
"type": "integer",
"title": "Rework Available"
},
"rework_used": {
"type": "integer",
"title": "Rework Used"
},
"status": {
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
"current_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Current Revision Id"
},
"revisions": {
"items": {
"$ref": "#/components/schemas/ShotRevisionPublic"
},
"type": "array",
"title": "Revisions",
"default": []
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"rework_available",
"rework_used",
"status",
"created_at",
"updated_at"
],
"title": "ShotPublic",
"description": "Public schema for Shot"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/v1/shots/{shot_id}¶
Delete Shot
Description
Delete a shot.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shot_id |
path | string | No |
Responses
{
"id": "5a628cea-9d4d-455a-ac2c-5382e7d02f84",
"production_request_id": null,
"shot_type": null,
"pose_preset_id": null,
"rework_available": 0,
"rework_used": 0,
"status": "PENDING",
"current_revision_id": null,
"revisions": [
{
"id": "ef95e4ac-22de-466f-84b6-22eda6ecf869",
"shot_id": "be1232c6-3400-4f5c-8f7a-cfc10562ef14",
"version": 0,
"notes": null,
"shot_status": null,
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "ee8e814a-4e00-4cb6-9b68-8d987485720f",
"shot_revision_id": "2bf997b2-4d13-4c37-b6d6-e13d419f821a",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "43879c04-00be-4b7f-8893-e9ecaf81d0d3",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "b7799dbf-0407-4b5a-b252-669fff6c66a5",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
],
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z"
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"production_request_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Production Request Id"
},
"shot_type": {
"anyOf": [
{
"$ref": "#/components/schemas/ShotTypePublic"
},
{
"type": "null"
}
]
},
"pose_preset_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Pose Preset Id"
},
"rework_available": {
"type": "integer",
"title": "Rework Available"
},
"rework_used": {
"type": "integer",
"title": "Rework Used"
},
"status": {
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
"current_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Current Revision Id"
},
"revisions": {
"items": {
"$ref": "#/components/schemas/ShotRevisionPublic"
},
"type": "array",
"title": "Revisions",
"default": []
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"rework_available",
"rework_used",
"status",
"created_at",
"updated_at"
],
"title": "ShotPublic",
"description": "Public schema for Shot"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shots/{shot_id}/download¶
Download Shot Revision Image
Description
Download the current revision image with metadata processing.
This endpoint: - Applies user's export configuration (format + metadata adapter) - Returns file with Content-Disposition for browser download - Filename generated by metadata adapter based on platform conventions
The image is processed according to the user's ExportConfiguration: - Format conversion (JPEG, PNG, WebP, AVIF) - Metadata injection (DEFAULT or OVS adapter) - Filename generation (adapter-specific naming conventions)
Args: db: Database session shot_id: Shot UUID current_user: Authenticated user
Returns: FileResponse with processed image and Content-Disposition header
Raises: 404: Shot not found 403: User not authorized 400: No current revision or no image 500: Image processing failed
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shot_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shots/{shot_id}/revision¶
Create Shot Revision
Description
Create a new revision for a shot with flexible image input.
This endpoint supports: - Multiple images per revision - Images from predictions, refines, or manual uploads (presigned URLs) - Sketch images for reference - Explicit status setting
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
shot_id |
path | string | No |
Request body
{
"shot_status": "PENDING",
"previous_revision_id": null,
"notes": null,
"images": [
{
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"image_data": null,
"sketch_image_url": null,
"sketch_image_data": null,
"notes": null,
"autogenerated": null
}
]
}
Schema of the request body
{
"properties": {
"shot_status": {
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
"previous_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Previous Revision Id"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"images": {
"items": {
"$ref": "#/components/schemas/ShotRevisionImageData"
},
"type": "array",
"title": "Images"
}
},
"type": "object",
"required": [
"shot_status",
"images"
],
"title": "CreateShotRevisionRequest",
"description": "Schema for creating a shot revision via the new unified endpoint.\nSupports multiple images with flexible input formats."
}
Responses
{
"id": "243b6202-5aa9-4b6a-83b2-8d36cfc95acd",
"shot_id": "f52eddd2-405b-44c2-ac5a-522259d53dba",
"version": 0,
"notes": null,
"shot_status": "PENDING",
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "3543e3c0-799e-4cb6-925e-af38643c3bad",
"shot_revision_id": "eb67d23c-243c-4072-a17f-9a99638967e6",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "fd65c38c-5843-4c62-ba0a-e8945b7315ad",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "475ec42d-be73-4e07-8cbe-e46baaac2920",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"shot_id": {
"type": "string",
"format": "uuid",
"title": "Shot Id"
},
"version": {
"type": "integer",
"title": "Version"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"shot_status": {
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
"shot_revision_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ShotRevisionStatus"
},
{
"type": "null"
}
]
},
"owner_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Owner Id"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"previous_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Previous Revision Id"
},
"images": {
"items": {
"$ref": "#/components/schemas/ShotRevisionImagePublic"
},
"type": "array",
"title": "Images",
"default": []
},
"display_name": {
"type": "string",
"title": "Display Name"
},
"effective_image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Effective Image Url"
},
"push_records": {
"items": {
"$ref": "#/components/schemas/ExternalImagePushPublic"
},
"type": "array",
"title": "Push Records",
"default": []
},
"push_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Push Status",
"description": "Aggregate push status across all integrations.\n\nReturns: None (no pushes), PENDING, IN_PROGRESS, AWAITING_CONFIRMATION, COMPLETED, or FAILED\nPriority: FAILED > IN_PROGRESS > AWAITING_CONFIRMATION > PENDING > COMPLETED",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"shot_id",
"version",
"shot_status",
"created_at",
"updated_at",
"display_name",
"push_status"
],
"title": "ShotRevisionPublic",
"description": "Public schema for ShotRevision"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shots/revisions/upload-url¶
Get Revision Upload Url
Description
Get a presigned URL for direct upload of revision images.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
content_type |
query | string | image/jpeg | No | |
filename |
query | string | No | ||
shot_id |
query | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
GET /api/v1/shots/revisions/{revision_id}¶
Get Revision
Description
Get a specific revision by ID.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
revision_id |
path | string | No |
Responses
{
"id": "b69cdb49-65b4-459d-8662-77ec8b632cdc",
"shot_id": "88622a83-54d8-48fc-a26e-ba13c72925e4",
"version": 0,
"notes": null,
"shot_status": "PENDING",
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "b47522a5-a58c-4a30-a717-e68c86159fa6",
"shot_revision_id": "5158e762-3710-440a-b052-e71e33914fb7",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "be780f7d-a6f3-46db-bb4a-b6eb46e5c7b7",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "5868b171-cf1b-4645-a5c5-1f8974e2b493",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"shot_id": {
"type": "string",
"format": "uuid",
"title": "Shot Id"
},
"version": {
"type": "integer",
"title": "Version"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"shot_status": {
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
"shot_revision_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ShotRevisionStatus"
},
{
"type": "null"
}
]
},
"owner_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Owner Id"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"previous_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Previous Revision Id"
},
"images": {
"items": {
"$ref": "#/components/schemas/ShotRevisionImagePublic"
},
"type": "array",
"title": "Images",
"default": []
},
"display_name": {
"type": "string",
"title": "Display Name"
},
"effective_image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Effective Image Url"
},
"push_records": {
"items": {
"$ref": "#/components/schemas/ExternalImagePushPublic"
},
"type": "array",
"title": "Push Records",
"default": []
},
"push_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Push Status",
"description": "Aggregate push status across all integrations.\n\nReturns: None (no pushes), PENDING, IN_PROGRESS, AWAITING_CONFIRMATION, COMPLETED, or FAILED\nPriority: FAILED > IN_PROGRESS > AWAITING_CONFIRMATION > PENDING > COMPLETED",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"shot_id",
"version",
"shot_status",
"created_at",
"updated_at",
"display_name",
"push_status"
],
"title": "ShotRevisionPublic",
"description": "Public schema for ShotRevision"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
DELETE /api/v1/shots/revisions/{revision_id}¶
Delete Shot Revision
Description
Delete a shot revision and its associated media resources.
This endpoint: - Detaches media resources for all images (handles file cleanup via MediaResource) - Deletes the specified revision from the database - If deleting the current revision, updates the shot's current_revision_id to the deleted revision's previous_revision_id (or None if there wasn't one)
Constraints: - Cannot delete a revision that is referenced by other revisions as their previous_revision
Args: db: Database session dependency revision_id: UUID of the revision to delete current_user: Current authenticated user media_service: Media resource service for detaching media
Returns: None (204 NO_CONTENT on success)
Raises: HTTPException: 404 if revision not found HTTPException: 403 if user not authorized HTTPException: 409 if business rules prevent deletion (referenced by other revisions) HTTPException: 500 if database error occurs
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
revision_id |
path | string | No |
Responses
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shots/revisions/{revision_id}/set-current¶
Set Revision As Current
Description
Set a revision as the current revision for the shot.
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
revision_id |
path | string | No |
Responses
{
"id": "4649ab5f-ef2a-4ed5-8bfe-82d8a069bbf1",
"shot_id": "2ab2ab6c-f92b-4ac0-8b95-61d29845ca55",
"version": 0,
"notes": null,
"shot_status": "PENDING",
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "71039ac9-28e8-4cad-b186-9e3f63f418cc",
"shot_revision_id": "85d69972-4ecb-4ea5-a810-38a6852dfc57",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "eaec7313-7428-42ad-b7e0-7b975d14d972",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "851ab1e1-957e-484b-8507-a8373fbd1958",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"shot_id": {
"type": "string",
"format": "uuid",
"title": "Shot Id"
},
"version": {
"type": "integer",
"title": "Version"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"shot_status": {
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
"shot_revision_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ShotRevisionStatus"
},
{
"type": "null"
}
]
},
"owner_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Owner Id"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"previous_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Previous Revision Id"
},
"images": {
"items": {
"$ref": "#/components/schemas/ShotRevisionImagePublic"
},
"type": "array",
"title": "Images",
"default": []
},
"display_name": {
"type": "string",
"title": "Display Name"
},
"effective_image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Effective Image Url"
},
"push_records": {
"items": {
"$ref": "#/components/schemas/ExternalImagePushPublic"
},
"type": "array",
"title": "Push Records",
"default": []
},
"push_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Push Status",
"description": "Aggregate push status across all integrations.\n\nReturns: None (no pushes), PENDING, IN_PROGRESS, AWAITING_CONFIRMATION, COMPLETED, or FAILED\nPriority: FAILED > IN_PROGRESS > AWAITING_CONFIRMATION > PENDING > COMPLETED",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"shot_id",
"version",
"shot_status",
"created_at",
"updated_at",
"display_name",
"push_status"
],
"title": "ShotRevisionPublic",
"description": "Public schema for ShotRevision"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shots/revisions/{revision_id}/export¶
Export Revision
Description
Export a revision to external systems (OVS).
Creates export records for each configured external integration and immediately triggers the push to the external service.
Requirements: - Revision must be in APPROVED status - Product must have at least one ExternalProductMapping configured
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
revision_id |
path | string | No |
Responses
{
"revision_id": "99ef22ab-a121-471b-94b8-445fd960035c",
"exports_created": 0,
"exports_skipped": 0,
"message": "string"
}
Schema of the response body
{
"properties": {
"revision_id": {
"type": "string",
"format": "uuid",
"title": "Revision Id"
},
"exports_created": {
"type": "integer",
"title": "Exports Created"
},
"exports_skipped": {
"type": "integer",
"title": "Exports Skipped"
},
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"revision_id",
"exports_created",
"exports_skipped",
"message"
],
"title": "ExportRevisionResponse",
"description": "Response for export revision endpoint."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shots/production-requests/{production_request_id}/export¶
Export Production Request
Description
Export all eligible shots from a look to external systems (OVS).
For each shot in the look: - If the current revision is APPROVED, creates export records for each configured external integration and immediately triggers the push to the external service.
Requirements: - Look must exist and user must have permission - Product must have at least one ExternalProductMapping configured - Only shots with APPROVED status are exported
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
production_request_id |
path | string | No |
Responses
{
"production_request_id": "af25dbc8-4fdd-4c0b-8935-0be0e2ad768b",
"revisions_processed": 0,
"revisions_skipped": 0,
"exports_created": 0,
"exports_skipped": 0,
"message": "string"
}
Schema of the response body
{
"properties": {
"production_request_id": {
"type": "string",
"format": "uuid",
"title": "Production Request Id"
},
"revisions_processed": {
"type": "integer",
"title": "Revisions Processed"
},
"revisions_skipped": {
"type": "integer",
"title": "Revisions Skipped"
},
"exports_created": {
"type": "integer",
"title": "Exports Created"
},
"exports_skipped": {
"type": "integer",
"title": "Exports Skipped"
},
"message": {
"type": "string",
"title": "Message"
}
},
"type": "object",
"required": [
"production_request_id",
"revisions_processed",
"revisions_skipped",
"exports_created",
"exports_skipped",
"message"
],
"title": "ExportProductionRequestResponse",
"description": "Response for export production request endpoint."
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
POST /api/v1/shots/revisions/{revision_id}/restore¶
Restore Shot Revision
Description
Restore a shot to a previous revision by deleting all revisions that came after it.
This endpoint: - Finds all revisions that came after the target in the chain - Detaches media resources and deletes those revisions - Sets the target revision as the current revision
Example: Given chain rev1 --> rev2 --> rev3 --> rev4 (current) - Restoring to rev2 deletes rev3 and rev4 - rev2 becomes the new current revision
If the target revision is already current, this is a no-op.
Args: db: Database session dependency revision_id: UUID of the revision to restore to current_user: Current authenticated user media_service: Media resource service for detaching media
Returns: ShotRevisionPublic: The restored revision
Raises: HTTPException: 404 if revision not found HTTPException: 403 if user not authorized HTTPException: 409 if business rules prevent restoration (external references) HTTPException: 500 if database error occurs
Input parameters
| Parameter | In | Type | Default | Nullable | Description |
|---|---|---|---|---|---|
OAuth2PasswordBearer |
header | string | N/A | No | |
revision_id |
path | string | No |
Responses
{
"id": "acdd95d9-1f50-45b5-8773-41ac0c020ba2",
"shot_id": "caecaa35-73ea-4932-85f5-f0cc6e0be47c",
"version": 0,
"notes": null,
"shot_status": "PENDING",
"shot_revision_status": null,
"owner_id": null,
"owner": null,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"previous_revision_id": null,
"images": [
{
"id": "47e04d1c-c03f-477a-9cbc-4a01d7baecfa",
"shot_revision_id": "a0030945-d07c-47e7-babc-17c117c7eaa0",
"source_type": "PREDICTION",
"prediction_id": null,
"refine_id": null,
"image_url": null,
"sketch_image_url": null,
"image_media": null,
"sketch_image_media": null,
"notes": null,
"autogenerated": true,
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"effective_image_url": null
}
],
"display_name": "string",
"effective_image_url": null,
"push_records": [
{
"id": "6465dfad-793f-4b57-8c7f-70e39ea86852",
"created_at": "2022-04-13T15:42:05.901Z",
"updated_at": "2022-04-13T15:42:05.901Z",
"integration_id": "be6bc417-b29c-4ace-b185-98df62fd7f98",
"push_status": "PENDING",
"pushed_at": null,
"completed_at": null,
"error_message": null
}
],
"push_status": null
}
Schema of the response body
{
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"shot_id": {
"type": "string",
"format": "uuid",
"title": "Shot Id"
},
"version": {
"type": "integer",
"title": "Version"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"shot_status": {
"$ref": "#/components/schemas/ProductionRequestStatusKey"
},
"shot_revision_status": {
"anyOf": [
{
"$ref": "#/components/schemas/ShotRevisionStatus"
},
{
"type": "null"
}
]
},
"owner_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Owner Id"
},
"owner": {
"anyOf": [
{
"$ref": "#/components/schemas/UserSummary"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
},
"previous_revision_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
],
"title": "Previous Revision Id"
},
"images": {
"items": {
"$ref": "#/components/schemas/ShotRevisionImagePublic"
},
"type": "array",
"title": "Images",
"default": []
},
"display_name": {
"type": "string",
"title": "Display Name"
},
"effective_image_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Effective Image Url"
},
"push_records": {
"items": {
"$ref": "#/components/schemas/ExternalImagePushPublic"
},
"type": "array",
"title": "Push Records",
"default": []
},
"push_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Push Status",
"description": "Aggregate push status across all integrations.\n\nReturns: None (no pushes), PENDING, IN_PROGRESS, AWAITING_CONFIRMATION, COMPLETED, or FAILED\nPriority: FAILED > IN_PROGRESS > AWAITING_CONFIRMATION > PENDING > COMPLETED",
"readOnly": true
}
},
"type": "object",
"required": [
"id",
"shot_id",
"version",
"shot_status",
"created_at",
"updated_at",
"display_name",
"push_status"
],
"title": "ShotRevisionPublic",
"description": "Public schema for ShotRevision"
}
⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.
Schemas¶
AgeClass¶
Type: string
BaseImagePublic¶
| Name | Type | Description |
|---|---|---|
image_url |
string | |
shot_type_id |
string(uuid) | |
shot_type_label |
string |
BodyType¶
Type: string
CreateShotRevisionRequest¶
| Name | Type | Description |
|---|---|---|
images |
Array<ShotRevisionImageData> | |
notes |
||
previous_revision_id |
||
shot_status |
ProductionRequestStatusKey |
DefaultShotTypes¶
Type: string
DraftProductionRequestsSummary¶
| Name | Type | Description |
|---|---|---|
generating_count |
integer | |
total_draft_production_requests |
integer |
ExportProductionRequestResponse¶
| Name | Type | Description |
|---|---|---|
exports_created |
integer | |
exports_skipped |
integer | |
message |
string | |
production_request_id |
string(uuid) | |
revisions_processed |
integer | |
revisions_skipped |
integer |
ExportRevisionResponse¶
| Name | Type | Description |
|---|---|---|
exports_created |
integer | |
exports_skipped |
integer | |
message |
string | |
revision_id |
string(uuid) |
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
FinalizeOutfitRequest¶
| Name | Type | Description |
|---|---|---|
outfit_id |
ID of existing outfit proposal to finalize | |
outfit_instruction |
Instructions for new outfit | |
outfit_product_ids |
Product IDs for new outfit | |
outfit_ref_imgs_urls |
Reference image URLs for new outfit |
Gender¶
Type: string
GenerateProductionRequestsRequest¶
| Name | Type | Description |
|---|---|---|
default_background_preset_id |
||
default_export_configuration_id |
||
default_height |
||
default_instructions |
string | |
default_resolution_preset_id |
||
default_style_id |
||
default_width |
||
generate_base_images |
boolean | |
generate_outfit |
boolean | |
generative_workflow_template_id |
Optional override for the generative workflow template attached to the created production requests. When omitted/null, inherited from the snapshot guidelines. Cross-org templates are rejected (422). | |
pose_preset_ids |
Override the pose presets from guidelines. When provided, these pose presets are baked into every created look instead of those from the shooting's default guidelines. | |
product_filters |
Product filters matching the read_products endpoint (archived, enabled, brand, brand_collection, demo, search, shot_statuses, gender, product_type, sort_by, sort_order, skip, limit) | |
product_ids |
Simple list of product IDs (use with generate_outfit=True for AI generation) | |
product_outfit_configs |
Per-product outfit configurations (use with generate_outfit=False for manual config) | |
production_id |
Target ShootingProduction. Defaults to the shooting's MAIN production. Pass a TEST production's id to create production requests in that test run. | |
readiness |
||
set_design_id |
Override the set design from guidelines. When provided, this set design is baked into every created look instead of the one from the shooting's default guidelines. | |
shot_type_ids |
Array<string(uuid)> | |
subject_ids |
Array<string(uuid)> | |
unisex_gender_preference |
Controls how UNISEX products are paired with subjects. MALE: pair only with male subjects. FEMALE: pair only with female subjects. UNISEX or None: pair with all subjects (default behavior). | |
use_subject_mannequin_double |
Tri-state mannequin-pipeline mode for the created PRs. ``null`` (default) = AUTO: server resolves at dispatch from the core product's ``product_type`` (restricted slugs in RESTRICTED_PRODUCT_TYPES opt in). ``true`` = ON (force mannequin). ``false`` = OFF (force regular). ``true`` is mutually exclusive with ``generative_workflow_template_id`` (422). |
GenerateProductionRequestsResponse¶
| Name | Type | Description |
|---|---|---|
generation_results |
Array<GenerationCreationResult> | |
production_requests |
Array<ProductionRequestPublic> | |
total_generations_created |
integer |
GenerationCreationResult¶
| Name | Type | Description |
|---|---|---|
generation_id |
string(uuid) | |
production_request_id |
string(uuid) | |
shot_id |
string(uuid) |
GuidelinesShotTypeRuleGroup¶
| Name | Type | Description |
|---|---|---|
rule_kind |
GuidelinesShotTypeRuleKind | |
rule_value |
string | |
shot_types |
Array<ShotTypePublic> |
GuidelinesShotTypeRuleGroupInput¶
| Name | Type | Description |
|---|---|---|
rule_kind |
GuidelinesShotTypeRuleKind | |
rule_value |
string | |
shot_type_ids |
Array<string(uuid)> |
GuidelinesShotTypeRuleKind¶
Type: string
HairColor¶
Type: string
HTTPValidationError¶
| Name | Type | Description |
|---|---|---|
detail |
Array<ValidationError> |
ManualOutfitCreate¶
| Name | Type | Description |
|---|---|---|
outfit_instruction |
||
outfit_product_ids |
Array<string(uuid)> | |
outfit_ref_imgs_urls |
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
Message¶
| Name | Type | Description |
|---|---|---|
message |
string |
OutfitGenerationStatus¶
Type: string
PosePresetPublic¶
| Name | Type | Description |
|---|---|---|
created_at |
string(date-time) | |
deleted_at |
||
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
ProductionRequestComputedStatus¶
Type: string
ProductionRequestOutfitPublic¶
| 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> | |
production_request_id |
string(uuid) | |
retry_count |
integer | |
updated_at |
string(date-time) |
ProductionRequestPublic¶
| Name | Type | Description |
|---|---|---|
assignee |
||
assignee_id |
||
background_preset_id |
||
created_at |
string(date-time) | |
deleted_at |
||
export_configuration_id |
||
generative_workflow_template_id |
||
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<ProductionRequestOutfitPublic> | |
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 |
||
readiness |
ProductionRequestReadiness | |
resolution_preset_id |
||
set_design |
||
set_design_id |
||
shooting_id |
string(uuid) | |
shot_status |
||
shots |
Array<ShotPublic> | |
style_id |
||
subject_id |
||
subject_name |
||
updated_at |
string(date-time) | |
use_subject_mannequin_double |
||
width |
ProductionRequestReadiness¶
Type: string
ProductionRequestsPublic¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
data |
Array<ProductionRequestPublic> |
ProductionRequestsSummaryPublic¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
data |
Array<ProductionRequestSummary> |
ProductionRequestStatusKey¶
Type: string
ProductionRequestStatusPublic¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
key |
string | |
label |
string | |
sorting |
integer |
ProductionRequestSummary¶
| Name | Type | Description |
|---|---|---|
assignee |
||
assignee_id |
||
created_at |
string(date-time) | |
id |
string(uuid) | |
outfit_generation_status |
||
outfit_products_count |
integer | |
product_cover_image_url |
||
product_id |
||
product_name |
||
product_sku |
||
readiness |
ProductionRequestReadiness | |
shooting_id |
string(uuid) | |
shot_status |
||
shots |
Array<ShotSummary> | |
updated_at |
string(date-time) |
ProductionRequestUpdate¶
| Name | Type | Description |
|---|---|---|
assignee_id |
||
auto_generate |
boolean | |
background_preset_id |
||
export_configuration_id |
||
generative_workflow_template_id |
Per-PR override for the workflow template. Cross-org templates are rejected (422). Mutually exclusive with ``use_subject_mannequin_double=True``. | |
height |
||
outfit_id |
||
product_id |
||
readiness |
||
resolution_preset_id |
||
shot_type_ids |
||
style_id |
||
subject_id |
||
use_subject_mannequin_double |
Tri-state mannequin-pipeline mode. PATCH-set ``null`` to switch the PR back to AUTO (resolved at dispatch from product_type), ``true`` to force mannequin (ON), ``false`` to force regular (OFF). Omit the key to leave the current value unchanged. | |
width |
ProductOutfitConfig¶
| Name | Type | Description |
|---|---|---|
background_preset_id |
||
export_configuration_id |
||
height |
||
outfit_instruction |
||
outfit_product_ids |
Array<string(uuid)> | |
outfit_ref_imgs_urls |
||
product_id |
string(uuid) | ID of the product for this configuration |
resolution_preset_id |
||
style_id |
||
width |
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 |
||
color_code |
||
color_name |
||
color_swatch_media |
||
colour |
||
cover_image_media |
||
cover_image_url |
||
created_at |
string(date-time) | |
data_image_urls |
Array<string> | |
deleted_at |
||
demo |
boolean | |
description |
||
ecommerce_description |
||
enabled |
boolean | |
exports_completed |
||
exports_total |
||
fit_type |
||
gender |
ProductGender | |
id |
string(uuid) | |
in_store_date |
||
incomplete |
boolean | |
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_production_request_id |
||
shots |
Array<> | |
sku |
||
sleeve_type |
||
style_code |
||
style_group_id |
||
theme |
||
type |
||
updated_at |
string(date-time) | |
year |
||
zone |
ProductShootingStatus¶
Type: string
PushStatus¶
Type: string
ReusableOutfitMatch¶
| Name | Type | Description |
|---|---|---|
outfit |
ProductionRequestOutfitPublic | |
source_product |
ProductPublic | |
source_production_request_id |
string(uuid) |
RevisionSource¶
Type: string
RoleName¶
Type: string
RolePublic¶
| Name | Type | Description |
|---|---|---|
description |
||
id |
string(uuid) | |
name |
RoleName |
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) | |
variant_index |
integer |
SetDesignPublic¶
| Name | Type | Description |
|---|---|---|
background_preset_id |
||
base_images |
Array<SetBaseImagePublic> | |
created_at |
string(date-time) | |
deleted_at |
||
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) |
ShootingCreate¶
| Name | Type | Description |
|---|---|---|
archived |
boolean | |
brand |
||
collection |
||
default_guidelines |
Inline guidelines to create alongside the shooting. Mutually exclusive with default_guidelines_id. | |
default_guidelines_id |
Default guidelines preset for this shooting (existing template) | |
description |
||
due_date |
string(date-time) | |
name |
string | |
organization_id |
Organization this shooting belongs to | |
phase |
ShootingPhase | Initial lifecycle phase. Only BRIEF and PRODUCTION are valid at creation. PRODUCTION (default) eagerly creates the MAIN production; BRIEF skips production creation. The intermediate phases (TEST_SHOOTING, PRODUCTS_SELECTION, AGREEMENT) and the terminal CLOSED phase are user-driven transitions reachable only via PATCH /shootings/{id}/phase, and are rejected here. |
require_test_shooting |
boolean | When True, MAIN production cannot be created until at least one TEST production exists for this shooting. Set-once at creation time; not editable afterwards. |
season |
ShootingGuidelinesCreate¶
| Name | Type | Description |
|---|---|---|
allow_back_shots_without_back_image |
boolean | |
auto_start_look_generations |
boolean | |
background_preset_id |
||
export_configuration_id |
||
generative_workflow_template_id |
Optional generative workflow template attached at guideline creation. Cross-org and invalid-validation-status templates are rejected at the route layer (422). | |
name |
string | |
organization_id |
Organization these guidelines belong to | |
owner_id |
||
pose_preset_ids |
Array<string(uuid)> | |
resolution_preset_id |
||
set_design_id |
||
shot_type_ids |
Array<string(uuid)> | |
shot_type_rules |
Optional list of shot-type rules to create alongside the guideline (one DB transaction). Each entry is one (rule_kind, rule_value) → list of shot_type_ids group. Omit to create the guideline with no rules. | |
stylist_id |
||
subject_ids |
Array<string(uuid)> |
ShootingGuidelinesPublic¶
| Name | Type | Description |
|---|---|---|
allow_back_shots_without_back_image |
boolean | |
auto_start_look_generations |
boolean | |
background_preset_id |
||
created_at |
string(date-time) | |
deleted_at |
||
export_configuration_id |
||
generative_workflow_template_id |
||
id |
string(uuid) | |
name |
string | |
organization_id |
||
owner_id |
||
pose_presets |
Array<PosePresetPublic> | |
resolution_preset_id |
||
set_design |
||
set_design_id |
||
shot_type_rules |
Array<GuidelinesShotTypeRuleGroup> | |
shot_types |
Array<ShotTypePublic> | |
stylist_id |
||
subjects |
Array<SubjectPublic> | |
updated_at |
string(date-time) |
ShootingHeaderGuidelinesPublic¶
| Name | Type | Description |
|---|---|---|
auto_start_look_generations |
boolean | |
background_preset_id |
||
created_at |
string(date-time) | |
export_configuration_id |
||
pose_presets |
Array<PosePresetPublic> | |
resolution_preset_id |
||
set_design_id |
||
shot_types |
Array<ShotTypePublic> | |
stylist |
||
stylist_id |
||
subjects |
Array<SubjectPublic> | |
updated_at |
string(date-time) |
ShootingHeaderPublic¶
| Name | Type | Description |
|---|---|---|
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) | |
public |
boolean | |
season |
||
shooting_type_id |
||
updated_at |
string(date-time) |
ShootingPhase¶
Type: string
ShootingPhaseUpdateRequest¶
| Name | Type | Description |
|---|---|---|
phase |
ShootingPhase | The new phase to transition to. |
ShootingProductIdsRequest¶
| Name | Type | Description |
|---|---|---|
product_ids |
Array<string(uuid)> | Product IDs to add, remove, or replace the set with. |
ShootingProductionCreate¶
| Name | Type | Description |
|---|---|---|
kind |
string | MAIN or TEST. |
ShootingProductionPublic¶
| Name | Type | Description |
|---|---|---|
archived |
boolean | |
created_at |
string(date-time) | |
deleted_at |
||
guidelines_id |
||
id |
string(uuid) | |
kind |
string | |
shooting_id |
string(uuid) | |
updated_at |
string(date-time) |
ShootingProductionsList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
data |
Array<ShootingProductionPublic> |
ShootingProductionUpdate¶
| Name | Type | Description |
|---|---|---|
archived |
ShootingProductsList¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
data |
Array<ProductPublic> |
ShootingPublic¶
| Name | Type | Description |
|---|---|---|
archived |
boolean | |
brand |
||
collection |
||
created_at |
string(date-time) | |
default_guidelines |
||
default_guidelines_id |
||
deleted_at |
||
description |
||
due_date |
||
id |
string(uuid) | |
name |
string | |
organization_id |
||
owner_id |
string(uuid) | |
phase |
||
require_test_shooting |
boolean | |
season |
||
shooting_type |
||
shooting_type_id |
||
shot_status |
||
status |
||
updated_at |
string(date-time) |
ShootingsPublic¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
data |
Array<ShootingPublic> |
ShootingStatus¶
Type: string
ShootingStatusCount¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
status |
ProductionRequestComputedStatus |
ShootingStatusFilter¶
Type: string
ShootingSummary¶
| Name | Type | Description |
|---|---|---|
status_breakdown |
Array<ShootingStatusCount> | |
total_production_requests |
integer | |
total_products |
integer |
ShootingTypePublic¶
| Name | Type | Description |
|---|---|---|
archived |
boolean | |
description |
||
id |
string(uuid) | |
key |
string | |
label |
string |
ShootingUpdate¶
| Name | Type | Description |
|---|---|---|
archived |
||
brand |
||
collection |
||
default_guidelines_id |
Default guidelines preset for this shooting | |
description |
||
due_date |
||
name |
||
organization_id |
Organization to transfer this shooting to | |
season |
ShotCreate¶
| Name | Type | Description |
|---|---|---|
production_request_id |
string(uuid) | |
shot_type_id |
ShotPublic¶
| Name | Type | Description |
|---|---|---|
created_at |
string(date-time) | |
current_revision_id |
||
id |
string(uuid) | |
pose_preset_id |
||
production_request_id |
||
revisions |
Array<ShotRevisionPublic> | |
rework_available |
integer | |
rework_used |
integer | |
shot_type |
||
status |
ProductionRequestStatusKey | |
updated_at |
string(date-time) |
ShotRevisionImageData¶
| Name | Type | Description |
|---|---|---|
autogenerated |
||
image_data |
||
image_url |
||
notes |
||
prediction_id |
||
refine_id |
||
sketch_image_data |
||
sketch_image_url |
||
source_type |
RevisionSource |
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 |
ProductionRequestStatusKey | |
updated_at |
string(date-time) | |
version |
integer |
ShotRevisionStatus¶
Type: string
ShotsPublic¶
| Name | Type | Description |
|---|---|---|
count |
integer | |
data |
Array<ShotPublic> |
ShotStatusFilter¶
Type: string
ShotSummary¶
| Name | Type | Description |
|---|---|---|
current_revision_id |
||
id |
string(uuid) | |
push_status |
||
shot_type |
||
status |
ProductionRequestStatusKey |
ShotTypeFraming¶
Type: string
ShotTypePublic¶
| Name | Type | Description |
|---|---|---|
core_focus |
boolean | |
created_at |
string(date-time) | |
default_shot_type |
||
deleted_at |
||
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 |
ShotUpdate¶
| Name | Type | Description |
|---|---|---|
current_revision_id |
||
rework_available |
||
rework_used |
||
shot_type_id |
StartGenerationsRequest¶
| Name | Type | Description |
|---|---|---|
generations_per_shot_type |
integer | Number of generations to create per shot type (1-10) |
StartGenerationsResponse¶
| Name | Type | Description |
|---|---|---|
generation_ids |
Array<string(uuid)> | |
generations_per_shot_type |
integer | |
message |
string | |
production_request_id |
string(uuid) |
StartShotTypeGenerationsRequest¶
| Name | Type | Description |
|---|---|---|
generations_count |
integer | Number of generations to create (1-10) |
shot_type_id |
string(uuid) | UUID of the shot type to generate for |
StartShotTypeGenerationsResponse¶
| Name | Type | Description |
|---|---|---|
generation_ids |
Array<string(uuid)> | |
generations_count |
integer | |
message |
string | |
production_request_id |
string(uuid) | |
shot_type_id |
string(uuid) |
StylistSummary¶
| Name | Type | Description |
|---|---|---|
id |
string(uuid) | |
name |
string |
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 |
||
deleted_at |
||
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) |
SubjectType¶
Type: string
UserSummary¶
| Name | Type | Description |
|---|---|---|
email |
string(email) | |
full_name |
||
id |
string(uuid) | |
role |
ValidationError¶
| Name | Type | Description |
|---|---|---|
ctx |
||
input |
||
loc |
Array<> | |
msg |
string | |
type |
string |
ViewAngle¶
Type: string
Security schemes¶
| Name | Type | Scheme | Description |
|---|---|---|---|
| OAuth2PasswordBearer | oauth2 |