Skip to main content
GET
/
v1
/
slug
/
filename-safe
Filename Safe
curl --request GET \
  --url https://api.example.com/v1/slug/filename-safe \
  --header 'X-API-Key: <api-key>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
filename
string
required

Filename to sanitize

​
replacement
string
default:_

Character to replace invalid chars with

​
max_length
integer
default:255

Maximum filename length

Required range: 1 <= x <= 255

Response

Successful Response