const data = await ctx.modules.uploads.prepare({
  // Request body
});

​
Public

No

​
Request

const data = await ctx.modules.uploads.prepare({
  // Request body
});

​
Request

Object containing the following properties:

PropertyType
metadataObject with properties:
    files (*)Array of objects:
    • multipart: boolean
    • path: string
    • mime: string (nullable)
    • contentLength: string

    (*) Required.

    ​
    Response

    ​
    Response

    Object containing the following properties:

    PropertyType
    upload (*)Object with properties:
    • files: Array of objects:
      • presignedChunks: Array of objects:
        • url: string
        • partNumber: number
        • contentLength: string
        • offset: string
      • path: string
      • mime: string (nullable)
      • contentLength: string
    • id: string
    • metadata: Object with properties:
      • bucket: string
      • contentLength: string
      • createdAt: string
      • updatedAt: string
      • completedAt: string (nullable)

      (*) Required.

      const data = await ctx.modules.uploads.prepare({
  // Request body
});

      ​
      Public

      No

      ​
      Request

      const data = await ctx.modules.uploads.prepare({
  // Request body
});

      ​
      Request

      Object containing the following properties:

      PropertyType
      metadataObject with properties:
        files (*)Array of objects:
        • multipart: boolean
        • path: string
        • mime: string (nullable)
        • contentLength: string

        (*) Required.

        ​
        Response

        ​
        Response

        Object containing the following properties:

        PropertyType
        upload (*)Object with properties:
        • files: Array of objects:
          • presignedChunks: Array of objects:
            • url: string
            • partNumber: number
            • contentLength: string
            • offset: string
          • path: string
          • mime: string (nullable)
          • contentLength: string
        • id: string
        • metadata: Object with properties:
          • bucket: string
          • contentLength: string
          • createdAt: string
          • updatedAt: string
          • completedAt: string (nullable)

          (*) Required.