API ReferenceHuman ModelsCreate a human model

Create a human model

POST
/human-models

Authorization

x-api-key<token>

API Key authentication via header

In: header

Request Body

application/jsonRequired
nameRequiredstring
additionalPromptstring
imageSettingsobject
curl -X POST "https://niravai.com/api/v1/human-models" \
  -H "x-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Elena Vance",
    "additionalPrompt": "Luxury fashion editorial headshot portrait",
    "imageSettings": {
      "gender": "Female",
      "age": "24",
      "culturalTraits": "Latin American",
      "skinTone": "Warm Olive",
      "eyeColor": "Brown",
      "hairStyle": "Long Wavy",
      "hairColor": "Dark Brown",
      "bodySize": "S",
      "bodyHeight": "Tall",
      "muscleDefinition": "Lean",
      "previews": [
        "http://example.com"
      ]
    }
  }'

Human model created successfully

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Elena Vance",
  "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  "additionalPrompt": "string",
  "imageSettings": {
    "gender": "Female",
    "age": "24",
    "culturalTraits": "Latin American",
    "skinTone": "Warm Olive",
    "eyeColor": "Brown",
    "hairStyle": "Long Wavy",
    "hairColor": "Dark Brown",
    "bodySize": "S",
    "bodyHeight": "Tall",
    "muscleDefinition": "Lean",
    "previews": [
      "http://example.com"
    ]
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z"
}

Previous

List all human models

Next

Upload an image to create a human model