Skip to main content

Store a new template

post/v1/videos/user-templates

Store a new template

Request

Body

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 255
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 1000
          },
          "category": {
            "type": [
              "string",
              "null"
            ],
            "maxLength": 100
          },
          "clips": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "tracks": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "composition_width": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 100,
            "maximum": 7680
          },
          "composition_height": {
            "type": [
              "integer",
              "null"
            ],
            "minimum": 100,
            "maximum": 4320
          },
          "is_public": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "thumbnail": {
            "type": [
              "string",
              "null"
            ]
          },
          "team_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "Base64 or URL"
          },
          "tags": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": "string",
              "maxLength": 50
            }
          }
        },
        "required": [
          "name",
          "clips",
          "tracks"
        ]
      }
    }
  }
}

Responses

201No description
Schema Structure
{
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"thumbnail": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"tags": {
"type": [
"array",
"null"
],
"items": {}
},
"composition_width": {
"type": "integer"
},
"composition_height": {
"type": "integer"
},
"is_public": {
"type": "boolean"
},
"usage_count": {
"type": "integer"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"clips": {
"type": "array",
"items": {}
},
"tracks": {
"type": "array",
"items": {}
}
},
"required": [
"id",
"name",
"slug",
"description",
"thumbnail",
"category",
"tags",
"composition_width",
"composition_height",
"is_public",
"usage_count",
"created_at",
"updated_at",
"clips",
"tracks"
]
}
},
"required": [
"success",
"data"
]
}
422Validation error
Schema Structure
{
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Errors overview."
},
"errors": {
"type": "object",
"description": "A detailed description of each field that failed validation.",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"required": [
"message",
"errors"
]
}