Create a template

Authorization

x-api-key<token>

API Key authentication via header

In: header

Request Body

application/jsonRequired

nameRequiredstring

descriptionstring

categoryRequiredstring

tagsarray<string>

itemsarray<object>

curl -X POST "https://niravai.com/api/v1/templates" \
  -H "x-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Template for shoe",
    "description": "Studio lighting template for fashion product",
    "category": "Fashion",
    "tags": [
      "shoe",
      "fashion"
    ],
    "items": [
      {
        "name": "Flatlay Shot",
        "mediaType": "image",
        "mode": "Style",
        "positivePrompt": "string",
        "negativePrompt": "string",
        "lightingStyle": "string",
        "cameraAngle": "eye_level",
        "poses": "string",
        "isModelIncludes": false
      }
    ]
  }'

Template created successfully

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Template for shoe",
  "description": "Studio lighting template for fashion product",
  "isDefault": false,
  "category": "Fashion",
  "tags": [
    "shoe",
    "fashion"
  ],
  "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
      "name": "Flatlay Shot",
      "mediaType": "image",
      "mode": "Style",
      "positivePrompt": "string",
      "negativePrompt": "string",
      "lightingStyle": "string",
      "cameraAngle": "eye_level",
      "poses": "string",
      "fileId": "string",
      "maskUri": "string",
      "overlayText": "string",
      "isModelIncludes": false,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Create a template

Authorization

Request Body

Response

TypeScript