Get upload

veryfront__get_upload

Requires project.uploads.read.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject UUID, slug or configured domain. Omit when the request context selects a project. Minimum length: 1.
upload_referencestringYesUpload UUID or project-relative path. A same-project storage prefix is accepted only when no literal relative path matches. Minimum length: 1.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__get_upload",
    "arguments": {
      "upload_reference": "example"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
idstringYesUpload UUID. Format: uuid.
pathstringYesProject-relative storage path.
file_namestringYesFile name from the upload record.
content_typestring or nullYesStored MIME type, or null when unspecified.
sizeintegerYesDeclared file size in bytes, from 0 through 9007199254740991. Minimum: 0. Maximum: 9007199254740991.
urlstring or nullYesAPI content URL; access depends on upload visibility. No cloud-storage signed URL is generated.
statusstringYesUpload lifecycle state: pending, active or failed. Values: "pending", "active", "failed".
visibilitystringYesEffective upload visibility: project, public or private. Values: "project", "public", "private".
created_atstringYesStored creation timestamp.
updated_atstringYesStored last-update timestamp.
deleted_atstring or nullYesStored soft-deletion timestamp, or null for an undeleted upload.
size_bytesintegerYesFile size in bytes; the same value as size. Minimum: 0. Maximum: 9007199254740991.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project UUID, slug or configured domain. Omit when the request context selects a project."
    },
    "upload_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Upload UUID or project-relative path. A same-project storage prefix is accepted only when no literal relative path matches."
    }
  },
  "required": [
    "upload_reference"
  ],
  "additionalProperties": false,
  "description": "Arguments for the get_upload tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Upload UUID."
    },
    "path": {
      "type": "string",
      "description": "Project-relative storage path."
    },
    "file_name": {
      "type": "string",
      "description": "File name from the upload record."
    },
    "content_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stored MIME type, or null when unspecified."
    },
    "size": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991,
      "description": "Declared file size in bytes, from 0 through 9007199254740991."
    },
    "url": {
      "type": [
        "string",
        "null"
      ],
      "description": "API content URL; access depends on upload visibility. No cloud-storage signed URL is generated."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "active",
        "failed"
      ],
      "description": "Upload lifecycle state: pending, active or failed."
    },
    "visibility": {
      "type": "string",
      "enum": [
        "project",
        "public",
        "private"
      ],
      "description": "Effective upload visibility: project, public or private."
    },
    "created_at": {
      "type": "string",
      "description": "Stored creation timestamp."
    },
    "updated_at": {
      "type": "string",
      "description": "Stored last-update timestamp."
    },
    "deleted_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stored soft-deletion timestamp, or null for an undeleted upload."
    },
    "size_bytes": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991,
      "description": "File size in bytes; the same value as size."
    }
  },
  "required": [
    "id",
    "path",
    "file_name",
    "content_type",
    "size",
    "url",
    "status",
    "visibility",
    "created_at",
    "updated_at",
    "deleted_at",
    "size_bytes"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_upload tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}