Space API
POST /url/create
Api key auth
application/json

Body Required

  • url string(uri) Required
  • uniqueId string
  • maxUses integer

    Default value is -1.

Responses

  • 200 application/json

    Short URL resource response

    Hide response attributes Show response attributes object
    • error boolean
    • timestamp string(date-time)
    • uniqueId string | null
    • message object
      Hide message attributes Show message attributes object
      • uniqueId string
      • originalUrl string
      • visits integer
      • maxUses integer

        Default value is -1.

      • createdAt string(date-time)
      • expiresAt string | null
      • urlSet object
        Hide urlSet attributes Show urlSet attributes object
        • webUrl string(uri)
        • portalUrl string(uri)
        • rawUrl string(uri)
        • shortUrl string(uri)
        • customUrl string(uri)
      • uploader object
        Hide uploader attributes Show uploader attributes object
        • uid integer
        • username string
        • role string

          Values are OWNER, ADMIN, USER, or TESTER.

        • avatar string | null
        • createdAt string(date-time)
        • invitor object
          Hide invitor attributes Show invitor attributes object
          • uid integer
          • username string
          • role string

            Values are OWNER, ADMIN, USER, or TESTER.

          • avatar string | null
          • createdAt string(date-time)
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • error boolean
    • timestamp string(date-time)
    • uniqueId string | null
POST /url/create 
curl \
 --request POST 'https://call.xap3y.space/v1/url/create' \
 --header "X-API-Key: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"url":"https://example.com","uniqueId":"string","maxUses":-1}'
Request examples 
{
  "url": "https://example.com",
  "uniqueId": "string",
  "maxUses": -1
}
Response examples (200) 
{
  "error": true,
  "timestamp": "2025-05-04T09:42:00Z",
  "uniqueId": "string",
  "message": {
    "uniqueId": "string",
    "originalUrl": "string",
    "visits": 42,
    "maxUses": -1,
    "createdAt": "2025-05-04T09:42:00Z",
    "expiresAt": "string",
    "urlSet": {
      "webUrl": "https://example.com",
      "portalUrl": "https://example.com",
      "rawUrl": "https://example.com",
      "shortUrl": "https://example.com",
      "customUrl": "https://example.com"
    },
    "uploader": {
      "uid": 42,
      "username": "string",
      "role": "OWNER",
      "avatar": "string",
      "createdAt": "2025-05-04T09:42:00Z",
      "invitor": {
        "uid": 42,
        "username": "string",
        "role": "OWNER",
        "avatar": "string",
        "createdAt": "2025-05-04T09:42:00Z"
      }
    }
  }
}
Response examples (400) 
{
  "error": true,
  "timestamp": "2025-05-04T09:42:00Z",
  "uniqueId": "string"
}