Powered by Redocly

AI-Presenter

Get Presenter info

Description

Note: This API route requires the image to be registered via the /register route.

The Person/Info Route is used to retrieve useful information on the people in a specific visual that was previously uploaded to the database.

Additionally, it provides a description of each person within the scene along with its available changes, which are supported by the Bria API.

This route should be used instead of the main /info route when you are only interested in information and available actions for the people in the image. With this route, you will save time by only obtaining information that is relevant to your needs.

Request
path Parameters
visual_id
required
string

visual id of the image, received after using the /upload or register route.

Example: f49943971e3039c7
header Parameters
api_token
required
string
Responses
200

Successful operation.

205

File hasn’t finished onboarding. Please call /info again until you get 200.

400

One of the details does not meet specification. Please call person/info again.

404

Specified Image does not exist.

405

Method not allowed.

500

Internal server error.

506

Insufficient data. The given input is not supported by the Bria API.

get/{visual_id}/person/info
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Modify Presenter
Description


Note: This API route requires the image to be registered via the /register route.


The Create Route is used to create a new visual, based on the changes requested by the user for a previously uploaded visual.


You can also use this route on a modified image by providing the sid from the response of the previously used route.


This route returns both the URL and the sid associated with the updated image.


Before making any modifications, please call the /info or person/info route to obtain information on the available presenters in the image, the available modifications, and their oracle values.


You should always include all the required changes in the request if you want to use multiple changes on a single person. It is not supported to make one request on a person with one change, take the SId from the result, and then use it in another request with a different change.


When you want to make changes on multiple people, you can make one request with all the desired changes on all the relevant people or make one request with all the desired changes on one person and then use the sid from the response in the request on the other person. 


Request 
path Parameters
visual_id
required
string
visual id of the image the user wants to create a new visual from.


 
 Example:  8487fb411f3c6716
header Parameters
api_token
required
string
 
Request Body schema: application/json
sid
string
This session id was obtained from the response of a route that had been applied to this visual id. If you have used another route on the provided visual before, and you would like the current route to modify the result of that route, please provide this information. This parameter is optional.


 
desired_resolution
string
The desired resolution of the updated image. This parameter is optional.


 Enum: "original" "nhd" "svga" "xga" "had" "wuxga" "uwfhd" "wqxga" "uwqhd" "uhd"  
Array of objects
The requested changes to the original visual.


 
Responses 
200
Successful operation.


400
Bad request.


404
Specified Image does not exist.


405
Method not allowed.


500
Internal server error.


506
Insufficient data. The given input is not supported by the Bria API.


post/{visual_id}/create
Request samples 
Response samples 
application/json
{}
➔ Next to Deprecated Soon