Create support capture upload session

POST/support/capture/upload-session

Header parameters

x-pile-capture-tokenstringrequired

Request body

application/json

titlestringrequired

min length 1

descriptionstring

prioritystring

Allowed:lowmediumhighurgent

tagsstring[]

urlstring

attachmentTypestring

default: "screenshot"

Allowed:screenshotvideodebugger_jsonlognetworkreplaytranscript

contentTypestring

fileNamestring

artifactsobject[]

Show properties

Array of object

attachmentTypestringrequired

Allowed:screenshotvideodebugger_jsonlognetworkreplaytranscript

fileNamestring

contentTypestring

visibilitystring

Allowed:publicprivate

metadataobject

default: {}

deviceInfoobject

multipartboolean

replayEventsany[]

max items 50000

includeNetworkBodiesboolean

Responses

200

Upload session

uploadUrlstringrequired

r2Keystringrequired

sessionIdstringrequired

uploadIdstring

partUploadUrlstring

shareUrlstring

uploadsobject[]

Show properties

Array of object

uploadUrlstringrequired

r2Keystringrequired

attachmentTypestringrequired

Allowed:screenshotvideodebugger_jsonlognetworkreplaytranscript

fileNamestringrequired

401

Invalid or expired token

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Parameters

x-pile-capture-tokenheader*

Bodyapplication/json

Request body

Request

curl -X POST 'https://pile.nyc/support/capture/upload-session' \
  -H 'x-pile-capture-token: string' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "description": "string",
  "priority": "low",
  "tags": [
    "string"
  ],
  "url": "string",
  "attachmentType": "screenshot",
  "contentType": "string",
  "fileName": "string",
  "artifacts": [
    {
      "attachmentType": "screenshot",
      "fileName": "string",
      "contentType": "string"
    }
  ],
  "visibility": "public",
  "metadata": {},
  "deviceInfo": {
    "property1": null,
    "property2": null
  },
  "multipart": true,
  "replayEvents": [
    null
  ],
  "includeNetworkBodies": true
}'

const response = await fetch("https://pile.nyc/support/capture/upload-session", {
  method: "POST",
  headers: {
    "x-pile-capture-token": "string",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"title\": \"string\",\n  \"description\": \"string\",\n  \"priority\": \"low\",\n  \"tags\": [\n    \"string\"\n  ],\n  \"url\": \"string\",\n  \"attachmentType\": \"screenshot\",\n  \"contentType\": \"string\",\n  \"fileName\": \"string\",\n  \"artifacts\": [\n    {\n      \"attachmentType\": \"screenshot\",\n      \"fileName\": \"string\",\n      \"contentType\": \"string\"\n    }\n  ],\n  \"visibility\": \"public\",\n  \"metadata\": {},\n  \"deviceInfo\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"multipart\": true,\n  \"replayEvents\": [\n    null\n  ],\n  \"includeNetworkBodies\": true\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/support/capture/upload-session",
    headers={
        "x-pile-capture-token": "string",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"title\": \"string\",\n  \"description\": \"string\",\n  \"priority\": \"low\",\n  \"tags\": [\n    \"string\"\n  ],\n  \"url\": \"string\",\n  \"attachmentType\": \"screenshot\",\n  \"contentType\": \"string\",\n  \"fileName\": \"string\",\n  \"artifacts\": [\n    {\n      \"attachmentType\": \"screenshot\",\n      \"fileName\": \"string\",\n      \"contentType\": \"string\"\n    }\n  ],\n  \"visibility\": \"public\",\n  \"metadata\": {},\n  \"deviceInfo\": {\n    \"property1\": null,\n    \"property2\": null\n  },\n  \"multipart\": true,\n  \"replayEvents\": [\n    null\n  ],\n  \"includeNetworkBodies\": true\n}",
)

Response

{
  "uploadUrl": "string",
  "r2Key": "string",
  "sessionId": "string",
  "uploadId": "string",
  "partUploadUrl": "string",
  "shareUrl": "string",
  "uploads": [
    {
      "uploadUrl": "string",
      "r2Key": "string",
      "attachmentType": "screenshot",
      "fileName": "string"
    }
  ]
}