Get upload

upload(input: UploadInput!): Upload!

Requires project.uploads.read.

Arguments

ArgumentTypeRequired
inputUploadInput!Yes

Input fields

input

UploadInput

FieldTypeRequiredDescription
projectReferenceString!YesProject UUID, slug or configured domain.
uploadReferenceString!YesUpload UUID or project-relative upload path.

Response

Returns Upload!. Open the type for its fields and nested types.

FieldTypeDescription
idID!Upload UUID.
pathString!Project-relative upload path, without a leading slash.
fileNameString!File name from the upload record.
contentTypeStringStored MIME type, or null when unspecified.
sizeBytesFloat!File size in bytes.
urlStringAPI URL that serves the upload; access depends on its visibility.
statusUploadMetadataStatus!pending until the bytes are stored, active when available, or failed.
visibilityUploadFolderVisibility!Effective visibility of the upload.

All fields of Upload.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query Upload($input: UploadInput!) {
  upload(input: $input) {
    id
    status
    createdAt
    updatedAt
    contentType
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "uploadReference": "example"
  }
}