Create a File

POST 
/v2/files

Create a File

Request

multipart/form-data

Body

required

file binary

Indicates the file you want to upload.

file_location string

Use this parameter to reference a file stored at a specific location. This must be the URL that points to an image file.

Responses

201

Created

application/json

Schema

Schema

data File

id uuid

The unique identifier for this file.

type string

The type represents the object being returned.

file_name string

The name of the file.

mime_type string

The mime type of the file.

file_size integer

The size of the file. Required when uploading files.

public boolean

DEPRECATED Whether the file public or not. Required when uploading files.

meta FileMeta

timestamps object

The date and time the file was created.

created_at string

The date and time the file was created.

dimensions object

The file dimensions.

width integer

The width of the file.

height integer

The height of the file.

links object

Links are used to allow you to move between requests.

self string

Single entities use a self parameter with a link to that specific resource.

link object

The publicly available URL for this file.

href string

The publicly available URL for this file.

Example (from schema)

{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "file",
    "file_name": "file_name.jpg",
    "mime_type": "image/jpeg",
    "file_size": 36000,
    "public": true,
    "meta": {
      "timestamps": {
        "created_at": "2023-10-11T13:02:25.293Z"
      },
      "dimensions": {
        "width": 1800,
        "height": 1000
      }
    },
    "links": {
      "self": "https://https://euwest.api.elasticpath.com//v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52"
    },
    "link": {
      "href": "https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png"
    }
  }
}

default

{
  "data": {
    "type": "file",
    "id": "f8cf26b3-6d38-4275-937a-624a83994702",
    "link": {
      "href": "https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png"
    },
    "file_name": "f6669358-85db-4367-9cde-1deb77acb5f4.png",
    "mime_type": "image/png",
    "file_size": 110041,
    "meta": {
      "dimensions": {
        "width": 1000,
        "height": 1000
      },
      "timestamps": {
        "created_at": "2018-03-13T13:45:21.673Z"
      }
    },
    "links": {
      "self": "https://useast.api.elasticpath.com/v2/files/f8cf26b3-6d38-4275-937a-624a83994702"
    }
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

file-location-invalid

{
  "errors": [
    {
      "title": "file_location invalid",
      "status": 422,
      "detail": "@/path/to/file.jpg is not a valid URL"
    }
  ]
}

file-not-uploaded

{
  "errors": [
    {
      "title": "Validation Failed",
      "status": 400,
      "detail": "You have not supplied a file to store"
    }
  ]
}

422

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

file-location-invalid

{
  "errors": [
    {
      "title": "file_location invalid",
      "status": 422,
      "detail": "@/path/to/file.jpg is not a valid URL"
    }
  ]
}

file-not-uploaded

{
  "errors": [
    {
      "title": "Validation Failed",
      "status": 400,
      "detail": "You have not supplied a file to store"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status intrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
request_id string
Internal request ID.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": 500,
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Loading...