Skip to content

Docs API

Media

Upload images to your media library and list them, so that image layers can use them.

The media library keeps the images that you upload. An image layer can use the URL of an uploaded image as its source. The library belongs to your user account, not to the company.

Method Path What it does
GET /v1/media Lists your images, 12 for each page, newest first.
POST /v1/media Uploads one image.

For each endpoint:

  • Auth: bearer token
  • Ability: api_requests
  • Rate limit: api (60 a minute)
  • Usage log: no

List media

HTTP

GET /v1/media
Parameter In Required Description
page query No The page number.

200 returns the standard Laravel paginator. Each item is a media record with a src field. src is the URL of the image conversion.

JSON

{
  "data": [
    {
      "id": 12,
      "file_name": "logo.png",
      "src": "https://snapsbrew.example/storage/12/conversions/logo-image.jpg"
    }
  ],
  "links": {"first": "...", "last": "...", "prev": null, "next": null},
  "meta": {"current_page": 1, "per_page": 12, "total": 1}
}

The example shows three fields of each item. The response also has the other columns of the media record.

Upload media

HTTP

POST /v1/media

Send the image as multipart/form-data.

Field Type Required Rules Description
file file Yes Must be an image The image to upload.

200 returns the media record with no data key:

JSON

{
  "id": 12,
  "file_name": "logo.png",
  "src": "https://snapsbrew.example/storage/12/conversions/logo-image.jpg"
}
Status Cause
401 The token is missing or wrong.
422 The file field is missing or is not an image.

The storage disk of the instance sets the host of src. See Storage.

Examples

Terminal

curl -X POST https://snapsbrew.example/api/v1/media \
  -H 'Authorization: Bearer <your-token>' \
  -H 'Accept: application/json' \
  -F 'file=@logo.png'

PHP

use Illuminate\Support\Facades\Http;

$media = Http::withToken(config('services.snapsbrew.token'))
    ->acceptJson()
    ->attach('file', file_get_contents('logo.png'), 'logo.png')
    ->post('https://snapsbrew.example/api/v1/media')
    ->throw()
    ->json();

// Use the URL as the image of a layer in a snap.
$variants = [['layer' => 'logo', 'image_url' => $media['src']]];

Edit this page on GitHub