Upload a preview image

PUT

/v1/resources/{name}/image

curl --request PUT \
  --url https://api.gampeon.com/v1/resources/example/image \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: image/png' \
  --data binary

• Production

PNG, JPEG or WebP up to 2 MB. The type is checked against the first bytes of the file. No SVG.

Not available with access tokens.

Rate limit: 30 per hour per account.

Authorizations

• session

Parameters

Path Parameters

name

required

string

/^[a-z0-9][a-z0-9_\-]{1,47}$/

Resource name

Request Body^required

The image

string format: binary

string format: binary

string format: binary

Responses

201

Stored

Media typeapplication/json

object

image

required

Path relative to the API

string

Example ^generated

{
  "image": "example"
}

400

Error codes: invalid_image

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

401

Error codes: unauthorized

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

403

Error codes: token_not_allowed, forbidden

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

404

Error codes: not_found

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

413

Error codes: file_too_large

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

415

Error codes: unsupported_media_type, invalid_image

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

429

Limit: 30 per hour per account. Error codes: rate_limited

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

503

Error codes: storage_disabled

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}