Pose Presets Endpoints¶

Pose Presets API endpoints.

Overview¶

Method	Endpoint	Description
POST	`/api/v1/pose-presets/`	Create Pose Preset
GET	`/api/v1/pose-presets/`	Read Pose Presets
GET	`/api/v1/pose-presets/{id}`	Read Pose Preset
PUT	`/api/v1/pose-presets/{id}`	Update Pose Preset
DELETE	`/api/v1/pose-presets/{id}`	Delete Pose Preset

API Reference¶

Sartiq Backend Server - Pose Presets 0.1.0¶

pose-presets¶

POST /api/v1/pose-presets/¶

Create Pose Preset

Description

Create new pose preset.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`organization_id`	query			No

Request body

application/json

{
    "name": "string",
    "prompt": null,
    "shot_type_id": "37e39a66-184c-4550-86e5-660b3b7d2d74",
    "pose_image": null,
    "owner_id": null,
    "organization_id": null
}

⚠️ 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": {
        "name": {
            "type": "string",
            "maxLength": 255,
            "title": "Name"
        },
        "prompt": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Prompt"
        },
        "shot_type_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shot Type Id"
        },
        "pose_image": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "$ref": "#/components/schemas/MediaInput"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Pose Image",
            "description": "URL or MediaInput for pose image"
        },
        "owner_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Owner Id"
        },
        "organization_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Organization Id",
            "description": "Organization this preset belongs to"
        }
    },
    "type": "object",
    "required": [
        "name",
        "shot_type_id"
    ],
    "title": "PosePresetCreate"
}

Responses

200 OK422 Unprocessable Entity

application/json

{
    "id": "5366354d-62b2-41ce-9349-e416a67c4094",
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "name": "string",
    "prompt": null,
    "shot_type_id": "2727a01e-9da3-4d8a-bb6c-b163155cf9fd",
    "owner_id": "875a4431-f0d7-40ff-9272-6a59290964f0",
    "organization_id": null,
    "pose_image_url": null,
    "pose_image_media": null,
    "deleted_at": null
}

⚠️ 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": {
        "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"
        },
        "prompt": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Prompt"
        },
        "shot_type_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shot Type Id"
        },
        "owner_id": {
            "type": "string",
            "format": "uuid",
            "title": "Owner Id"
        },
        "organization_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Organization Id"
        },
        "pose_image_url": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Pose Image Url"
        },
        "pose_image_media": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/MediaResourcePublic"
                },
                {
                    "type": "null"
                }
            ]
        },
        "deleted_at": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "date-time"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Deleted At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "created_at",
        "updated_at",
        "name",
        "shot_type_id",
        "owner_id"
    ],
    "title": "PosePresetPublic"
}

application/json

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

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

Schema of the response body

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

GET /api/v1/pose-presets/¶

Read Pose Presets

Description

Retrieve pose presets.

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`limit`	query	integer	100	No
`organization_id`	query			No
`owner_id`	query			No
`shot_type_id`	query			No
`skip`	query	integer	0	No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "data": [
        {
            "id": "0e081f27-e57d-4e51-98f3-dacb15cafaf4",
            "created_at": "2022-04-13T15:42:05.901Z",
            "updated_at": "2022-04-13T15:42:05.901Z",
            "name": "string",
            "prompt": null,
            "shot_type_id": "9d9751b7-3006-410b-b123-1cd932cf5e73",
            "owner_id": "c46d8962-bce9-49eb-87c1-b1fafa3aed1c",
            "organization_id": null,
            "pose_image_url": null,
            "pose_image_media": null,
            "deleted_at": null
        }
    ],
    "count": 0
}

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

Schema of the response body

{
    "properties": {
        "data": {
            "items": {
                "$ref": "#/components/schemas/PosePresetPublic"
            },
            "type": "array",
            "title": "Data"
        },
        "count": {
            "type": "integer",
            "title": "Count"
        }
    },
    "type": "object",
    "required": [
        "data",
        "count"
    ],
    "title": "PosePresetsPublic"
}

application/json

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

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

Schema of the response body

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

GET /api/v1/pose-presets/{id}¶

Read Pose Preset

Description

Get pose preset by ID.

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`id`	path	string		No
`organization_id`	query			No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "id": "77096224-6974-45ab-be8f-78f0317eb1fb",
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "name": "string",
    "prompt": null,
    "shot_type_id": "a3229101-afd5-4c4f-bcb1-852d4f163744",
    "owner_id": "ff458d96-265c-40fc-a1c3-dfbc4138c760",
    "organization_id": null,
    "pose_image_url": null,
    "pose_image_media": null,
    "deleted_at": null
}

⚠️ 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": {
        "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"
        },
        "prompt": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Prompt"
        },
        "shot_type_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shot Type Id"
        },
        "owner_id": {
            "type": "string",
            "format": "uuid",
            "title": "Owner Id"
        },
        "organization_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Organization Id"
        },
        "pose_image_url": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Pose Image Url"
        },
        "pose_image_media": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/MediaResourcePublic"
                },
                {
                    "type": "null"
                }
            ]
        },
        "deleted_at": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "date-time"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Deleted At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "created_at",
        "updated_at",
        "name",
        "shot_type_id",
        "owner_id"
    ],
    "title": "PosePresetPublic"
}

application/json

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

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

Schema of the response body

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

PUT /api/v1/pose-presets/{id}¶

Update Pose Preset

Description

Update a pose preset.

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`id`	path	string		No
`organization_id`	query			No

Request body

application/json

{
    "name": null,
    "prompt": null,
    "shot_type_id": null,
    "pose_image": null,
    "owner_id": null,
    "organization_id": null
}

⚠️ 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": {
        "name": {
            "anyOf": [
                {
                    "type": "string",
                    "maxLength": 255
                },
                {
                    "type": "null"
                }
            ],
            "title": "Name"
        },
        "prompt": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Prompt"
        },
        "shot_type_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Shot Type Id"
        },
        "pose_image": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "$ref": "#/components/schemas/MediaInput"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Pose Image",
            "description": "URL or MediaInput for pose image"
        },
        "owner_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Owner Id"
        },
        "organization_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Organization Id",
            "description": "Organization to transfer this preset to"
        }
    },
    "type": "object",
    "title": "PosePresetUpdate"
}

Responses

200 OK422 Unprocessable Entity

application/json

{
    "id": "e960287a-c215-40e8-a098-c8122337c15e",
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "name": "string",
    "prompt": null,
    "shot_type_id": "7850f008-f34a-4f70-877f-a2e774c8a3f7",
    "owner_id": "798abc5d-ab98-4304-804a-e2f48e33c2a9",
    "organization_id": null,
    "pose_image_url": null,
    "pose_image_media": null,
    "deleted_at": null
}

⚠️ 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": {
        "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"
        },
        "prompt": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Prompt"
        },
        "shot_type_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shot Type Id"
        },
        "owner_id": {
            "type": "string",
            "format": "uuid",
            "title": "Owner Id"
        },
        "organization_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Organization Id"
        },
        "pose_image_url": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Pose Image Url"
        },
        "pose_image_media": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/MediaResourcePublic"
                },
                {
                    "type": "null"
                }
            ]
        },
        "deleted_at": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "date-time"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Deleted At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "created_at",
        "updated_at",
        "name",
        "shot_type_id",
        "owner_id"
    ],
    "title": "PosePresetPublic"
}

application/json

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

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

Schema of the response body

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

DELETE /api/v1/pose-presets/{id}¶

Delete Pose Preset

Description

Delete a pose preset.

Input parameters

Parameter	In	Type	Default	Nullable
`OAuth2PasswordBearer`	header	string	N/A	No
`id`	path	string		No
`organization_id`	query			No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "message": "string"
}

⚠️ 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": {
        "message": {
            "type": "string",
            "title": "Message"
        }
    },
    "type": "object",
    "required": [
        "message"
    ],
    "title": "Message"
}

application/json

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

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

Schema of the response body

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

POST /api/v1/pose-presets/{id}/restore¶

Restore Pose Preset

Description

Restore a soft-deleted pose preset (admin only).

Input parameters

Parameter	In	Type	Default	Nullable	Description
`OAuth2PasswordBearer`	header	string	N/A	No
`id`	path	string		No

Responses

200 OK422 Unprocessable Entity

application/json

{
    "id": "8900c520-cb91-414e-88e3-b5d4cb73452e",
    "created_at": "2022-04-13T15:42:05.901Z",
    "updated_at": "2022-04-13T15:42:05.901Z",
    "name": "string",
    "prompt": null,
    "shot_type_id": "618bbf62-d25e-464d-80f8-e327fb5cf865",
    "owner_id": "d7696784-d61a-4ed3-bf97-b66180673272",
    "organization_id": null,
    "pose_image_url": null,
    "pose_image_media": null,
    "deleted_at": null
}

⚠️ 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": {
        "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"
        },
        "prompt": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Prompt"
        },
        "shot_type_id": {
            "type": "string",
            "format": "uuid",
            "title": "Shot Type Id"
        },
        "owner_id": {
            "type": "string",
            "format": "uuid",
            "title": "Owner Id"
        },
        "organization_id": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "uuid"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Organization Id"
        },
        "pose_image_url": {
            "anyOf": [
                {
                    "type": "string"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Pose Image Url"
        },
        "pose_image_media": {
            "anyOf": [
                {
                    "$ref": "#/components/schemas/MediaResourcePublic"
                },
                {
                    "type": "null"
                }
            ]
        },
        "deleted_at": {
            "anyOf": [
                {
                    "type": "string",
                    "format": "date-time"
                },
                {
                    "type": "null"
                }
            ],
            "title": "Deleted At"
        }
    },
    "type": "object",
    "required": [
        "id",
        "created_at",
        "updated_at",
        "name",
        "shot_type_id",
        "owner_id"
    ],
    "title": "PosePresetPublic"
}

application/json

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

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

Schema of the response body

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

Schemas¶

HTTPValidationError¶

Name	Type	Description
`detail`	Array<ValidationError>

MediaInput¶

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

MediaResourcePublic¶

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

MediaResourceType¶

Type: string

Message¶

Name	Type	Description
`message`	string

PosePresetCreate¶

Name	Type	Description
`name`	string
`organization_id`		Organization this preset belongs to
`owner_id`
`pose_image`		URL or MediaInput for pose image
`prompt`
`shot_type_id`	string(uuid)

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)

PosePresetsPublic¶

Name	Type	Description
`count`	integer
`data`	Array<PosePresetPublic>

PosePresetUpdate¶

Name	Type	Description
`name`
`organization_id`		Organization to transfer this preset to
`owner_id`
`pose_image`		URL or MediaInput for pose image
`prompt`
`shot_type_id`

ValidationError¶

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

Security schemes¶

Name	Type	Scheme	Description
OAuth2PasswordBearer	oauth2