Create Upload Urls

Creates one or more upload URLs which can be used by the client to upload raw file data. Content URls and uploaded content will be garbage collected after 24 hours if not attached to a draft or published item. Detailed pricing info around uploading content can be found here: https://learn.microsoft.com/en-us/gaming/playfab/features/pricing/meters/catalog-meters

Allowed entity token types: title, master_player_account, title_player_account

POST

Catalog

CreateUploadUrls

Create Upload Urls

curl --request POST \
  --url https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Files": [
    {
      "FileName": "textures.zip"
    },
    {
      "FileName": "sprites.png"
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls"

payload = { "Files": [{ "FileName": "textures.zip" }, { "FileName": "sprites.png" }] }
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Files: [{FileName: 'textures.zip'}, {FileName: 'sprites.png'}]})
};

fetch('https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Files' => [
        [
                'FileName' => 'textures.zip'
        ],
        [
                'FileName' => 'sprites.png'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls"

	payload := strings.NewReader("{\n  \"Files\": [\n    {\n      \"FileName\": \"textures.zip\"\n    },\n    {\n      \"FileName\": \"sprites.png\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Files\": [\n    {\n      \"FileName\": \"textures.zip\"\n    },\n    {\n      \"FileName\": \"sprites.png\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Files\": [\n    {\n      \"FileName\": \"textures.zip\"\n    },\n    {\n      \"FileName\": \"sprites.png\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "UploadUrls": [
      {
        "Id": "11111111-1111-1111-1111-111111111111",
        "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/11111111-1111-1111-1111-111111111111/textures.zip",
        "FileName": "textures.zip"
      },
      {
        "Id": "22222222-2222-2222-2222-222222222222",
        "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/22222222-2222-2222-2222-222222222222/sprites.png",
        "FileName": "sprites.png"
      }
    ]
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Authorizations

X-EntityToken

string

header

required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Upload URLs point to Azure Blobs; clients must follow the Microsoft Azure Storage Blob Service REST API pattern for uploading content. The response contains upload URLs and IDs for each file. The IDs and URLs returned must be added to the item metadata and committed using the CreateDraftItem or UpdateDraftItem Item APIs.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Files

object[]

Description of the files to be uploaded by the client.

Show child attributes

Response

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Example:

{
  "UploadUrls": [
    {
      "Id": "11111111-1111-1111-1111-111111111111",
      "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/11111111-1111-1111-1111-111111111111/textures.zip",
      "FileName": "textures.zip"
    },
    {
      "Id": "22222222-2222-2222-2222-222222222222",
      "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/22222222-2222-2222-2222-222222222222/sprites.png",
      "FileName": "sprites.png"
    }
  ]
}

Last modified on October 1, 2026

⌘I

Create Upload Urls

curl --request POST \
  --url https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Files": [
    {
      "FileName": "textures.zip"
    },
    {
      "FileName": "sprites.png"
    }
  ]
}
'

import requests

url = "https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls"

payload = { "Files": [{ "FileName": "textures.zip" }, { "FileName": "sprites.png" }] }
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Files: [{FileName: 'textures.zip'}, {FileName: 'sprites.png'}]})
};

fetch('https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Files' => [
        [
                'FileName' => 'textures.zip'
        ],
        [
                'FileName' => 'sprites.png'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls"

	payload := strings.NewReader("{\n  \"Files\": [\n    {\n      \"FileName\": \"textures.zip\"\n    },\n    {\n      \"FileName\": \"sprites.png\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Files\": [\n    {\n      \"FileName\": \"textures.zip\"\n    },\n    {\n      \"FileName\": \"sprites.png\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Catalog/CreateUploadUrls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Files\": [\n    {\n      \"FileName\": \"textures.zip\"\n    },\n    {\n      \"FileName\": \"sprites.png\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "UploadUrls": [
      {
        "Id": "11111111-1111-1111-1111-111111111111",
        "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/11111111-1111-1111-1111-111111111111/textures.zip",
        "FileName": "textures.zip"
      },
      {
        "Id": "22222222-2222-2222-2222-222222222222",
        "Url": "https://endpoint.blob.core.windows.net/some-identifier-private/22222222-2222-2222-2222-222222222222/sprites.png",
        "FileName": "sprites.png"
      }
    ]
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Create Upload Urls

Authorizations

Body

Response