openapi: 3.0.3
info:
title: 'Reica API'
description: ''
version: 1.0.0
servers:
-
url: 'https://getreica.com'
paths:
/api/v1/system/options:
get:
summary: 'Get all system options.'
operationId: getAllSystemOptions
description: 'This endpoint returns a list of options or a specific system options.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
option: resize
value: '3'
properties:
data:
type: object
properties:
option:
type: string
example: resize
value:
type: string
example: '3'
tags:
- Endpoints
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: ''
example: null
'/api/v1/rerun/{image}':
post:
summary: ''
operationId: postApiV1RerunImage
description: ''
parameters: []
responses: { }
tags:
- Endpoints
parameters:
-
in: path
name: image
description: ''
example: expedita
required: true
schema:
type: string
/api/v1/user/folders:
get:
summary: 'Get all user folders.'
operationId: getAllUserFolders
description: 'This endpoint returns a list of all folders along with their related information for the authenticated user.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 01jkawd4eexfdq2tyf66xe5tpw
name: doloremque
type: photo
user_id: 39
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
-
id: 01jkawd4ep468vb34gpjg6p77n
name: est
type: photo
user_id: 715
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
properties:
data:
type: array
example:
-
id: 01jkawd4eexfdq2tyf66xe5tpw
name: doloremque
type: photo
user_id: 39
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
-
id: 01jkawd4ep468vb34gpjg6p77n
name: est
type: photo
user_id: 715
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
items:
type: object
properties:
id:
type: string
example: 01jkawd4eexfdq2tyf66xe5tpw
name:
type: string
example: doloremque
type:
type: string
example: photo
user_id:
type: integer
example: 39
parent_id:
type: string
example: null
created_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
updated_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
tags:
- Folders
/api/v1/folders:
get:
summary: 'Get all folders.'
operationId: getAllFolders
description: 'This endpoint returns a list of all folders along with their related information.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 01jkawd4fajgzc6pdjqhb7x184
name: minus
type: background_removal
user_id: 98
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
-
id: 01jkawd4fh8n0nfcf49gsjkx6f
name: repellat
type: model
user_id: 71
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
properties:
data:
type: array
example:
-
id: 01jkawd4fajgzc6pdjqhb7x184
name: minus
type: background_removal
user_id: 98
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
-
id: 01jkawd4fh8n0nfcf49gsjkx6f
name: repellat
type: model
user_id: 71
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
items:
type: object
properties:
id:
type: string
example: 01jkawd4fajgzc6pdjqhb7x184
name:
type: string
example: minus
type:
type: string
example: background_removal
user_id:
type: integer
example: 98
parent_id:
type: string
example: null
created_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
updated_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
tags:
- Folders
post:
summary: 'Create a new folder.'
operationId: createANewFolder
description: 'This endpoint allows the authenticated user to create a new folder.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 01jkawd4fyv9d1cxyk8yajpaa4
name: officiis
type: photo
user_id: 36
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 01jkawd4fyv9d1cxyk8yajpaa4
name:
type: string
example: officiis
type:
type: string
example: photo
user_id:
type: integer
example: 36
parent_id:
type: string
example: null
created_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
updated_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
tags:
- Folders
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: 'The name of the folder to create.'
example: sed
type:
type: string
description: "The type of the folder. Default value is 'photo'."
example: assumenda
'/api/v1/folders/{id}':
get:
summary: 'Display the specified folder by ID.'
operationId: displayTheSpecifiedFolderByID
description: 'This endpoint returns the details of a specific folder for the authenticated user.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 01jkawd4gfkjww3gadxr4me4eh
name: neque
type: photo
user_id: 69
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 01jkawd4gfkjww3gadxr4me4eh
name:
type: string
example: neque
type:
type: string
example: photo
user_id:
type: integer
example: 69
parent_id:
type: string
example: null
created_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
updated_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
tags:
- Folders
delete:
summary: 'Delete the specified folder by ID.'
operationId: deleteTheSpecifiedFolderByID
description: 'This endpoint allows the authenticated user to delete a specific folder.'
parameters: []
responses: { }
tags:
- Folders
parameters:
-
in: path
name: id
description: 'The ID of the folder.'
example: 01hp4t1y3e0amzvsymm85y137r
required: true
schema:
type: string
/api/v1/child/folder:
post:
summary: 'Create a new child folder inside an existing folder.'
operationId: createANewChildFolderInsideAnExistingFolder
description: 'This endpoint allows the authenticated user to create a new child folder within an existing parent folder.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 01jkawd4rjts9cac867azjt3wz
name: eveniet
type: model
user_id: 261
parent_id: null
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 01jkawd4rjts9cac867azjt3wz
name:
type: string
example: eveniet
type:
type: string
example: model
user_id:
type: integer
example: 261
parent_id:
type: string
example: null
created_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
updated_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
tags:
- Folders
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
folder_id:
type: string
description: 'The ID of the parent folder.'
example: animi
name:
type: string
description: 'The name of the child folder.'
example: ad
/api/v1/child/image:
post:
summary: 'Add a new image to a folder.'
operationId: addANewImageToAFolder
description: 'This endpoint allows the authenticated user to add a new image to a specified folder.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 01jkawd4sfsj90hw5y7tcjtq63
name: in
url: 'https://via.placeholder.com/640x480.png/00ee99?text=sit'
image_size: null
user_id: 822
request_id: 01jkawd4sd1ywqd32qr03tj427
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 01jkawd4sfsj90hw5y7tcjtq63
name:
type: string
example: in
url:
type: string
example: 'https://via.placeholder.com/640x480.png/00ee99?text=sit'
image_size:
type: string
example: null
user_id:
type: integer
example: 822
request_id:
type: string
example: 01jkawd4sd1ywqd32qr03tj427
created_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
updated_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
tags:
- Folders
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
folder_id:
type: string
description: 'The ID of the folder to add the image to.'
example: vel
name:
type: string
description: 'The name of the image.'
example: et
url:
type: string
description: 'The URL of the image.'
example: 'https://www.wisozk.net/error-aut-voluptatem-placeat-voluptatibus-non-eius'
/api/v1/images:
get:
summary: 'Get all images.'
operationId: getAllImages
description: "This endpoint returns a list of images\nfor the authenticated user."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 01jkawd4j4f13agffeagp7zw5z
name: et
url: 'https://via.placeholder.com/640x480.png/0055cc?text=dolores'
image_size: null
user_id: 814
request_id: 01jkawd4j159dxn2d339z5zvan
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
-
id: 01jkawd4jxtdsd74n7cmnv32em
name: natus
url: 'https://via.placeholder.com/640x480.png/00aa00?text=eos'
image_size: null
user_id: 816
request_id: 01jkawd4jvkr4n78xsdptr8nt6
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
properties:
data:
type: array
example:
-
id: 01jkawd4j4f13agffeagp7zw5z
name: et
url: 'https://via.placeholder.com/640x480.png/0055cc?text=dolores'
image_size: null
user_id: 814
request_id: 01jkawd4j159dxn2d339z5zvan
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
-
id: 01jkawd4jxtdsd74n7cmnv32em
name: natus
url: 'https://via.placeholder.com/640x480.png/00aa00?text=eos'
image_size: null
user_id: 816
request_id: 01jkawd4jvkr4n78xsdptr8nt6
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
items:
type: object
properties:
id:
type: string
example: 01jkawd4j4f13agffeagp7zw5z
name:
type: string
example: et
url:
type: string
example: 'https://via.placeholder.com/640x480.png/0055cc?text=dolores'
image_size:
type: string
example: null
user_id:
type: integer
example: 814
request_id:
type: string
example: 01jkawd4j159dxn2d339z5zvan
created_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
updated_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
tags:
- Images
'/api/v1/images/{id}':
get:
summary: 'Get a specific image by ID.'
operationId: getASpecificImageByID
description: "This endpoint returns the details of a specific image\nfor the authenticated user."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 01jkawd4kx78e6edf18hk0a7ct
name: sed
url: 'https://via.placeholder.com/640x480.png/00aa00?text=vel'
image_size: null
user_id: 818
request_id: 01jkawd4kwskmjp4ssecfewyc3
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 01jkawd4kx78e6edf18hk0a7ct
name:
type: string
example: sed
url:
type: string
example: 'https://via.placeholder.com/640x480.png/00aa00?text=vel'
image_size:
type: string
example: null
user_id:
type: integer
example: 818
request_id:
type: string
example: 01jkawd4kwskmjp4ssecfewyc3
created_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
updated_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
tags:
- Images
put:
summary: 'Update a specific image by ID.'
operationId: updateASpecificImageByID
description: "This endpoint allows the authenticated user\nto update the name of a specific image."
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 01jkawd4mypxn5pgpj3sy2bjpn
name: aliquid
url: 'https://via.placeholder.com/640x480.png/00aabb?text=ipsum'
image_size: null
user_id: 820
request_id: 01jkawd4mxmg0dw82acym97b2f
created_at: '2025-02-05T11:02:28.000000Z'
updated_at: '2025-02-05T11:02:28.000000Z'
properties:
data:
type: object
properties:
id:
type: string
example: 01jkawd4mypxn5pgpj3sy2bjpn
name:
type: string
example: aliquid
url:
type: string
example: 'https://via.placeholder.com/640x480.png/00aabb?text=ipsum'
image_size:
type: string
example: null
user_id:
type: integer
example: 820
request_id:
type: string
example: 01jkawd4mxmg0dw82acym97b2f
created_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
updated_at:
type: string
example: '2025-02-05T11:02:28.000000Z'
tags:
- Images
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: ''
example: nobis
required:
- name
parameters:
-
in: path
name: id
description: 'The ID of the image.'
example: 01ht2jhq6w8rqdr4j49dqndvbf
required: true
schema:
type: string
'/api/v1/images/{image}':
delete:
summary: 'Delete a specific image by ID.'
operationId: deleteASpecificImageByID
description: "This endpoint allows the authenticated user\nto delete a specific image."
parameters: []
responses: { }
tags:
- Images
parameters:
-
in: path
name: image
description: 'The image.'
example: 01ht2jhq6w8rqdr4j49dqndvbf
required: true
schema:
type: string
'/api/v1/download/{image_id}/{format}':
get:
summary: ''
operationId: getApiV1DownloadImage_idFormat
description: ''
parameters: []
responses:
302:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n \n \n \n\n Redirecting to https://getreica.com/login\n \n \n Redirecting to https://getreica.com/login.\n \n"
tags:
- Images
parameters:
-
in: path
name: image_id
description: 'The ID of the image.'
example: 01ht2jhq6w8rqdr4j49dqndvbf
required: true
schema:
type: string
-
in: path
name: format
description: ''
example: beatae
required: true
schema:
type: string
/api/v1/notifications/all:
get:
summary: 'Returns all unread notifications'
operationId: returnsAllUnreadNotifications
description: ''
parameters: []
responses:
302:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n \n \n \n\n Redirecting to https://getreica.com/login\n \n \n Redirecting to https://getreica.com/login.\n \n"
tags:
- Notifications
'/api/v1/notifications/mark-as-read/{id}':
get:
summary: 'Mark one notification as read'
operationId: markOneNotificationAsRead
description: ''
parameters: []
responses:
302:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n \n \n \n\n Redirecting to https://getreica.com/login\n \n \n Redirecting to https://getreica.com/login.\n \n"
tags:
- Notifications
parameters:
-
in: path
name: id
description: 'The ID of the mark as read.'
example: iusto
required: true
schema:
type: string
/api/v1/notifications/mark-all-as-read:
get:
summary: 'Mark all notifications as read'
operationId: markAllNotificationsAsRead
description: ''
parameters: []
responses:
302:
description: ''
content:
text/plain:
schema:
type: string
example: "\n\n \n \n \n\n Redirecting to https://getreica.com/login\n \n \n Redirecting to https://getreica.com/login.\n \n"
tags:
- Notifications
/api/v1/workflow/background_remover:
post:
summary: 'Background removal'
operationId: backgroundRemoval
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
image:
type: string|null
description: 'The image file to be processed for background removal. Can be null if `image_url` is provided.'
example: '"data:image/jpg;base64,/9j/4QC8RXhpZg..."'
bg_template:
type: string
description: 'The ID of the background template to be applied.'
example: 01hqnjhg6e7yw80002fyzc4bv4
product:
type: string
description: 'The ID of the product associated with the image.'
example: 01hb6da7tds27dec2aw7depd9h
image_url:
type: string|null
description: 'The URL of the image to be processed if no file is uploaded.'
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/resize/2a845b77-b211-4b86-987b-5144ed65d474_out-524.png'
/api/v1/workflow/resize:
post:
summary: Resize
operationId: resize
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
channel:
type: string
description: 'The channel to which the image is being resized. Must be one of the available channels as configured in the application.'
example: instagram
enum:
- instagram_portrait
- instagram_landscape
- instagram_square
- instagram_stories
- facebook_cover
- facebook_square
- facebook_portrait
- facebook_landscape
- facebook_stories
- tiktok
- youtube_banner
- linkedin_profile_banner
- linkedin_page_cover
- linkedin_post
- pinterest_pin_image
- twitter_cover
- twitter_square
- twitter_landscape
image:
type: string|null
description: 'The image file to be processed for background removal. Can be null if `image_url` is provided.'
example: '"data:image/jpg;base64,/9j/4QC8RXhpZg..."'
image_url:
type: string|null
description: 'The URL of the image to be processed if no file is uploaded.'
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/resize/2a845b77-b211-4b86-987b-5144ed65d474_out-524.png'
required:
- channel
/api/v1/workflow/vto:
post:
summary: 'Virtual try on'
operationId: virtualTryOn
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
cloth_image:
type: string|null
description: 'The image file to be processed for background removal. Can be null if `image_url` is provided.'
example: '"data:image/jpg;base64,/9j/4QC8RXhpZg..."'
virtual_option_id:
type: string
description: 'The ID of the virtual try on option.'
example: 01hv6xgwqvx3w7v9b27h30p06m
image_url:
type: string|null
description: 'The URL of the image to be processed if no file is uploaded.'
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/resize/2a845b77-b211-4b86-987b-5144ed65d474_out-524.png'
/api/v1/workflow/missinghead:
post:
summary: MissingHead
operationId: missingHead
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
image:
type: string|null
description: 'The image file to be processed for background removal. Can be null if `image_url` is provided.'
example: '"data:image/jpg;base64,/9j/4QC8RXhpZg..."'
localization:
type: string
description: 'The ID of the localization option.'
example: 01hxtwp6w9nzy01z4m5k1r7ey9
gender:
type: string
description: 'The gender of the person, must be one of the allowed values (e.g., man, woman).'
example: man
enum:
- man
- woman
image_url:
type: string|null
description: 'The URL of the image to be processed if no file is uploaded.'
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/resize/2a845b77-b211-4b86-987b-5144ed65d474_out-524.png'
face_expression:
type: string
description: 'The face expression selected, must be one of the pre-configured options.'
example: smile
enum:
- smiling
- sad
- angry
- bored
- calm
- disappointed
- happy
- 'in love'
- nervous
- shy
- surprised
bg_gradient:
type: string
description: 'The HEX code representing the background color gradient.'
example: '#000000'
required:
- gender
/api/v1/workflow/localization:
post:
summary: Localization
operationId: localization
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
image:
type: string|null
description: 'The image file to be processed for background removal. Can be null if `image_url` is provided.'
example: '"data:image/jpg;base64,/9j/4QC8RXhpZg..."'
object:
type: string
description: 'The ID of the localization option.'
example: 01hxtwp6w9nzy01z4m5k1r7ey9
age:
type: integer
description: 'The age the model should have'
example: 16
gender:
type: string
description: 'The gender of the person, must be one of the allowed values (e.g., man, woman).'
example: man
enum:
- man
- woman
image_url:
type: string|null
description: 'The URL of the image to be processed if no file is uploaded.'
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/resize/2a845b77-b211-4b86-987b-5144ed65d474_out-524.png'
required:
- gender
/api/v1/workflow/backgroundmarketplace:
post:
summary: 'Background marketplace'
operationId: backgroundMarketplace
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
image:
type: string|null
description: 'The image file to be processed for background removal. Can be null if `image_url` is provided.'
example: '"data:image/jpg;base64,/9j/4QC8RXhpZg..."'
object:
type: string
description: 'The HEX code representing the color of the background.'
example: '#F6F7F8'
image_url:
type: string|null
description: 'The URL of the image to be processed if no file is uploaded.'
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/resize/2a845b77-b211-4b86-987b-5144ed65d474_out-524.png'
/api/v1/workflow/outpainting:
post:
summary: Zoomout
operationId: zoomout
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
top:
type: number
description: 'The top value for padding or margin. Must be a numeric value of either 256 or 512.'
example: 256.0
enum:
- '256'
- '512'
right:
type: number
description: 'The right value for padding or margin. Must be a numeric value of either 256 or 512.'
example: 512.0
enum:
- '256'
- '512'
bottom:
type: number
description: 'The bottom value for padding or margin. Must be a numeric value of either 256 or 512.'
example: 256.0
enum:
- '256'
- '512'
left:
type: number
description: 'The left value for padding or margin. Must be a numeric value of either 256 or 512.'
example: 512.0
enum:
- '256'
- '512'
image:
type: string|null
description: 'The image file to be processed for background removal. Can be null if `image_url` is provided.'
example: '"data:image/jpg;base64,/9j/4QC8RXhpZg..."'
image_url:
type: string|null
description: 'The URL of the image to be processed if no file is uploaded.'
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/resize/2a845b77-b211-4b86-987b-5144ed65d474_out-524.png'
/api/v1/workflow/copycat:
post:
summary: Copycat
operationId: copycat
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
image:
type: string|null
description: 'The image file to be processed for background removal. Can be null if `image_url` is provided.'
example: '"data:image/jpg;base64,/9j/4QC8RXhpZg..."'
strength:
type: number
description: 'The similarity value, ranging from 0 to 1 with a step of 0.1, indicating how closely the output should resemble the original.'
example: 1.6
image_url:
type: string|null
description: 'The URL of the image to be processed if no file is uploaded.'
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/resize/2a845b77-b211-4b86-987b-5144ed65d474_out-524.png'
/api/v1/workflow/upscale:
post:
summary: Upscale
operationId: upscale
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
scale:
type: string
description: 'The scale factor for resizing the image. Allowed values are 1.5, 2, 2.5, 3, or 4.'
example: '2'
enum:
- '1.5'
- '2'
- '2.5'
- '3'
- '3.5'
- '4'
image:
type: string|null
description: 'The image file to be processed for background removal. Can be null if `image_url` is provided.'
example: '"data:image/jpg;base64,/9j/4QC8RXhpZg..."'
image_url:
type: string|null
description: 'The URL of the image to be processed if no file is uploaded.'
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/resize/2a845b77-b211-4b86-987b-5144ed65d474_out-524.png'
required:
- scale
/api/v1/workflow/generate:
post:
summary: Generate
operationId: generate
description: ''
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
name: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id: 15
url: 'https://stage.getreica.com/storage/placeholder.gif'
request_id: 01j7ethy1jj4sx017640jsqx4g
id: 01j7ethy1wa323ee3b9a4865mm
updated_at: '2024-09-10T20:38:44.000000Z'
created_at: '2024-09-10T20:38:44.000000Z'
properties:
data:
type: object
properties:
name:
type: string
example: '01j7ethy1jj4sx017640jsqx4g 10-09-2024'
user_id:
type: integer
example: 15
url:
type: string
example: 'https://stage.getreica.com/storage/placeholder.gif'
request_id:
type: string
example: 01j7ethy1jj4sx017640jsqx4g
id:
type: string
example: 01j7ethy1wa323ee3b9a4865mm
updated_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
created_at:
type: string
example: '2024-09-10T20:38:44.000000Z'
404:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
data: null
message: "You do not have enough credit to complete this action, Get more credits here"
properties:
data:
type: string
example: null
message:
type: string
example: "You do not have enough credit to complete this action, Get more credits here"
-
description: ''
type: object
example:
data: null
message: 'We are sorry but this endpoint is currently disabled, try later or contact us'
properties:
data:
type: string
example: null
message:
type: string
example: 'We are sorry but this endpoint is currently disabled, try later or contact us'
tags:
- Workflows
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
options:
type: array
description: 'Array of options per each section feature.'
example:
- hair-style-1
- general-21
- accessories-2
items:
type: string
/api/v1/workflow/options/background_templates:
get:
summary: 'Background Removal options'
operationId: backgroundRemovalOptions
description: 'Fetches and caches the background removal options.'
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n{\n \"name\": \"Modern table 1\",\n \"id\": \"01hqn06m95vaftssq1fjrbn0v4\",\n \"background\": \"backgrounds/iFvbaQtWvIRrDs3KTNkEGJChAeOXSL4pAyDOaYxI.png\",\n \"background_url\": \"https://genshoot.s3.eu-west-2.amazonaws.com/backgrounds/iFvbaQtWvIRrDs3KTNkEGJChAeOXSL4pAyDOaYxI.png\"\n },\n {\n \"name\": \"Glass Table 1\",\n \"id\": \"01hqnhc10k5dxtjaveyqr0prtm\",\n \"background\": \"backgrounds/shhlm9CdHCPpqCILVwUKwvTUdN3cZYtYJ3W2wSxQ.png\",\n \"background_url\": \"https://genshoot.s3.eu-west-2.amazonaws.com/backgrounds/shhlm9CdHCPpqCILVwUKwvTUdN3cZYtYJ3W2wSxQ.png\"\n },\n}"
tags:
- 'Workflows Options'
/api/v1/workflow/options/objects:
get:
summary: 'Products options'
operationId: productsOptions
description: 'Fetches and caches the genshoot product options.'
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n {\n \"name\": \"bag\",\n \"id\": \"01haa0xwstpnc73ck95n4zbe6b\",\n \"translated_label\": \"\"\n},\n{\n \"name\": \"jacket\",\n \"id\": \"01haa0ymdb1b07xqxzdybcea5m\",\n \"translated_label\": \"\"\n},\n}"
tags:
- 'Workflows Options'
/api/v1/workflow/options/vto:
get:
summary: 'Virtual Try-On options'
operationId: virtualTryOnOptions
description: 'Fetches and caches the virtual try-on options.'
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n {\n \"type\": \"Upper body\",\n \"gender\": \"woman\",\n \"thumbnail\": \"thumbnails/cxilxvfuBfiCLNx8T8IF06aIznN2gnDMHHtA7CoC.png\",\n \"id\": \"01hv1zjxv72v0tbtmzt738fn26\",\n \"thumbnail_url\": \"https://genshoot.s3.eu-west-2.amazonaws.com/thumbnails/cxilxvfuBfiCLNx8T8IF06aIznN2gnDMHHtA7CoC.png\"\n},\n{\n \"type\": \"Upper body\",\n \"gender\": \"woman\",\n \"thumbnail\": \"thumbnails/yLVtMbg76WOrmkpdazQchSVAK6DFIsEFIfhoD6vk.png\",\n \"id\": \"01hv7g9gq9nxzgjnxx8axegx6n\",\n \"thumbnail_url\": \"https://genshoot.s3.eu-west-2.amazonaws.com/thumbnails/yLVtMbg76WOrmkpdazQchSVAK6DFIsEFIfhoD6vk.png\"\n},\n}"
tags:
- 'Workflows Options'
/api/v1/workflow/options/localization:
get:
summary: 'Localization options'
operationId: localizationOptions
description: 'Fetches and caches the localization options.'
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: "{\n\t{\n\t\"value\": \"Italian\",\n\t\t\"id\": \"01hxsnzfkyjdqrytmbfe4gccp2\",\n\t\t\"translated_label\": \"\"\n\t},\n\t{\n\t\t\"value\": \"Afghan\",\n\t\t\"id\": \"01hxtwp6w9nzy01z4m5k1r7ey3\",\n\t\t\"translated_label\": \"\"\n\t}\n}"
tags:
- 'Workflows Options'
/api/v1/workflow/options/generate:
get:
summary: 'Generate options'
operationId: generateOptions
description: 'Return all the prompt generate options.'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
section: 'Style of Photo'
features:
-
feature_name: General
options:
'General 1':
id: 01hgzf5ysqqkkgdkzjtfjm20kw
image: 'https://genshoot.s3.eu-west-2.amazonaws.com/options/FFmYuZr1NPNKl7m2tTOyngKH5DNAJbOBpGctlXXy.png'
properties:
section:
type: string
example: 'Style of Photo'
features:
type: array
example:
-
feature_name: General
options:
'General 1':
id: 01hgzf5ysqqkkgdkzjtfjm20kw
image: 'https://genshoot.s3.eu-west-2.amazonaws.com/options/FFmYuZr1NPNKl7m2tTOyngKH5DNAJbOBpGctlXXy.png'
items:
type: object
properties:
feature_name:
type: string
example: General
options:
type: object
properties:
'General 1':
type: object
properties:
id:
type: string
example: 01hgzf5ysqqkkgdkzjtfjm20kw
image:
type: string
example: 'https://genshoot.s3.eu-west-2.amazonaws.com/options/FFmYuZr1NPNKl7m2tTOyngKH5DNAJbOBpGctlXXy.png'
tags:
- 'Workflows Options'
tags:
-
name: Endpoints
description: ''
-
name: Folders
description: "\nAPIs for managing folders"
-
name: Images
description: "\nAPIs for managing images"
-
name: Notifications
description: "\nAPIs for managing notifications"
-
name: Workflows
description: "\nAPIs for managing workflows"
-
name: 'Workflows Options'
description: "\nAPIs for getting the necessary options to run the workflows"
components:
securitySchemes:
default:
type: http
scheme: bearer
description: 'You can retrieve your token by visiting your dashboard and clicking API token.'
security:
-
default: []