Quick Start

Good to know: A quick start guide can be good to help folks get up and running with your API in a few steps. Some people prefer diving in with the basics rather than meticulously reading every page of documentation!

Get your API keys

Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.

You can generate an API key from your Studio at any time.

Make your first request

To make your first request, send an authenticated request to the models endpoint. This will generate a model, The generation process takes approximately 3 minutes. After generation, you can call the Get Model interface to obtain the download link

Generative model.

POST https://api.myapi.com/open-api/sumeru/sdk/model/generate

Generate a 3D virtual human from a photo

Headers

Name	Type	Description
auth_ak*	String	Your API key
Content-Type*	String	multipart/form-data

Request Body

Name	Type	Description
file*	File	Portrait photo file
sex*	Integer	Virtual Human Nature, Input number: 1 :Female 0 :Male
eyelidType	Integer	Eyelid type, Input number: 1: Single eyelid 2: Double eyelid

200 Model Successfully generated

{
    "data": {
        "waitTime":30,
        "modelId":"22223698866223744"
    },
    "code": 200,
    "message": "success"
}

Responses Object

The response object returned by the request generation model

{
    "data": null,
    "code": 500,
    "message": "The photo does not recognize a face or has an incorrect photo format"
}

data Object The specific object returned

• waitTime Integer Estimated waiting time (seconds)

• modelId String Model Unique Identification

code Integer The status identifier returned by the request, with 200 indicating success and others indicating failure

message String The prompt information returned by the interface

Good to know: You can use the API Method block to fully document an API method. You can also sync your API blocks with an OpenAPI file or URL to auto-populate them.

Take a look at how you might call this method using our official libraries, or via curl:

curl

curl https://api.myapi.com/v1/pet  
    -u YOUR_API_KEY:  
    -d name='Wilson'  
    -d species='dog'  
    -d owner_id='sha7891bikojbkreuy'