Create destination (POST /destinations)

A destination is storage of yours that Mynth writes finished images into, so url on the result points at your own domain. Name it on a generation request with its name, not its id.

The secret is write-only: it is stored in a vault and no endpoint returns it. name cannot be changed later. Destinations covers the path and URL templates, which is where most of the configuration is.

Request body

namestringrequired

Destination slug. Immutable after creation. Matches /^[a-z0-9-]+$/.

≥ 1 characters≤ 64 charactersmatches ^[a-z0-9-]+$

configobjectrequired

path_templatestringrequired: ≤ 2048 characters
url_templatestring: URL template used to create an image URL. It must include a {path} which is a resolved path to file from path_template.
Example:
path_template -> "/images/{id}"
On upload path becomes /images/img_si1EywtFZMvDArkcVSSsN759VFNbHtE_.webp
url_template: "https://my-cdn.my-domain.com/{path}"
The url in the response will be: "https://my-cdn.my-domain.com/images/img_si1EywtFZMvDArkcVSSsN759VFNbHtE_.webp"
Note: The double // are automatically removed and replaced with single slash.
format: includesmatches \{path\}

providerobjectrequired

id"bunny"required
storage_zonestringrequired
regionstring: "de""uk""ny""la""sg""se""br""jh"

secretobjectrequired

passwordstringrequired

Response

Destination created

dataobjectrequired

idstringrequired
namestringrequired
providerjsonrequired
configjsonrequired
created_atstringrequired: format: date-time
updated_atstringrequired: format: date-time

Errors

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.