Create upload

http
POST /projects/{project_reference}/uploads

Create a pending upload at a project path and return the signed URL and headers for the PUT request that sends the bytes. Requires project.uploads.write.

Servers

json
[
  {
    "url": "https://api.veryfront.com"
  }
]

Authentication

json
[
  {
    "bearerAuth": []
  },
  {
    "apiKeyAuth": []
  }
]
json
{
  "bearerAuth": {
    "type": "http",
    "scheme": "bearer",
    "bearerFormat": "JWT or API Key",
    "description": "Use a JWT bearer token or a Veryfront API key in the `Authorization` header."
  },
  "apiKeyAuth": {
    "type": "apiKey",
    "in": "header",
    "name": "X-API-Key",
    "description": "Alternative API key header for `vf_<prefix>_<secret>` tokens."
  }
}

Parameters

NameLocationRequiredDescription
project_referencepathYesProject slug, UUID, or domain that identifies the project.

Parameter contracts

json
[
  {
    "schema": {
      "$ref": "#/components/schemas/ProjectReference"
    },
    "required": true,
    "description": "Project slug, UUID, or domain that identifies the project.",
    "name": "project_reference",
    "in": "path"
  }
]

Request body

json
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Project-relative path where the upload is stored."
          },
          "file_path": {
            "type": "string",
            "description": "Another spelling of path. Send one of the two."
          },
          "content_type": {
            "type": "string",
            "description": "MIME type of the file"
          },
          "size_bytes": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991,
            "description": "File size in bytes (required for quota tracking)."
          },
          "size": {
            "type": "integer",
            "exclusiveMinimum": 0,
            "maximum": 9007199254740991,
            "description": "Another spelling of size_bytes. Send one of the two."
          }
        }
      }
    }
  }
}

Responses

201

Signed upload URL created.

json
{
  "description": "Signed upload URL created.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "upload_url": {
            "type": "string",
            "description": "Temporary cloud-storage URL for the upload PUT request."
          },
          "path": {
            "type": "string",
            "description": "Project-relative path of the upload."
          },
          "status": {
            "type": "string",
            "enum": [
              "pending"
            ],
            "description": "Always pending until the bytes are stored."
          },
          "file_upload_url": {
            "type": "string",
            "description": "The same URL as upload_url."
          },
          "file_path": {
            "type": "string",
            "description": "Storage path of the upload, with the project ID prefix."
          },
          "upload_id": {
            "type": "string",
            "description": "UUID of the pending upload record."
          },
          "required_headers": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Headers that must be included in the PUT request to the upload URL",
            "example": {
              "Content-Type": "image/png",
              "x-goog-content-length-range": "0,1048576"
            }
          }
        },
        "required": [
          "upload_url",
          "path",
          "status",
          "file_upload_url",
          "file_path",
          "upload_id",
          "required_headers"
        ]
      }
    }
  }
}

400

Bad request

json
{
  "description": "Bad request",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

json
{
  "description": "Unauthorized",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

402

Payment required

json
{
  "description": "Payment required",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/QuotaProblem"
      }
    }
  }
}

403

Forbidden

json
{
  "description": "Forbidden",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

404

Not found

json
{
  "description": "Not found",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

409

An upload was created at the same path concurrently

json
{
  "description": "An upload was created at the same path concurrently",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

500

Server error

json
{
  "description": "Server error",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

Referenced contracts

components/parameters/ProjectReference

json
{
  "schema": {
    "$ref": "#/components/schemas/ProjectReference"
  },
  "required": true,
  "description": "Project slug, UUID, or domain that identifies the project.",
  "name": "project_reference",
  "in": "path"
}

components/schemas/ProjectReference

json
{
  "type": "string"
}

components/schemas/Problem

json
{
  "type": "object",
  "properties": {
    "cause": {
      "type": "string",
      "enum": [
        "schedule_concurrency_forbidden",
        "schedule_fire_in_progress",
        "schedule_run_limit_reached"
      ],
      "description": "Schedule admission refusal."
    },
    "idempotency": {
      "type": "object",
      "properties": {
        "state": {
          "type": "string",
          "enum": [
            "in_progress",
            "payload_mismatch",
            "outcome_unknown"
          ]
        },
        "operation": {
          "type": "string",
          "minLength": 1
        },
        "retryable": {
          "type": "boolean"
        },
        "retry_after_seconds": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "expires_at": {
          "type": [
            "string",
            "null"
          ]
        },
        "recovery": {
          "type": "object",
          "properties": {
            "available": {
              "type": "boolean"
            },
            "description": {
              "type": "string"
            },
            "resource_url": {
              "type": "string"
            }
          },
          "required": [
            "available",
            "description"
          ]
        }
      },
      "required": [
        "state",
        "operation",
        "retryable",
        "retry_after_seconds",
        "expires_at"
      ],
      "description": "Replay status, retry timing, and recovery lookup."
    },
    "type": {
      "type": "string",
      "description": "URI reference identifying the problem type",
      "example": "https://api.veryfront.com/errors/validation-failed"
    },
    "title": {
      "type": "string",
      "description": "Short human-readable summary of the problem",
      "example": "Validation Failed"
    },
    "status": {
      "type": "integer",
      "minimum": 100,
      "maximum": 599,
      "description": "HTTP status code",
      "example": 400
    },
    "code": {
      "type": "string",
      "description": "Stable machine-readable error code",
      "example": "RUN_INVALID_INPUT"
    },
    "detail": {
      "type": "string",
      "description": "Human-readable explanation specific to this occurrence",
      "example": "The 'email' field must be a valid email address"
    },
    "instance": {
      "type": "string",
      "description": "URI reference identifying the specific occurrence",
      "example": "/projects/my-project/members"
    },
    "slug": {
      "type": "string",
      "description": "Stable identifier for the problem type",
      "example": "validation-failed"
    },
    "category": {
      "type": "string",
      "enum": [
        "AUTH",
        "RESOURCE",
        "VALIDATION",
        "DATABASE",
        "SUBSCRIPTION",
        "INTEGRATION",
        "INTERNAL"
      ],
      "description": "API error category",
      "example": "VALIDATION"
    },
    "suggestion": {
      "type": "string",
      "description": "Suggested action to resolve the problem",
      "example": "Check the request body and query parameters against the API documentation."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string",
            "description": "Field path that caused the error",
            "example": "email"
          },
          "message": {
            "type": "string",
            "description": "Error message for this field",
            "example": "Invalid email format"
          },
          "code": {
            "type": "string",
            "description": "Error code for this field",
            "example": "INVALID_FORMAT"
          }
        },
        "required": [
          "field",
          "message"
        ]
      },
      "description": "Detailed field-level errors for validation failures"
    }
  },
  "required": [
    "type",
    "title",
    "status"
  ]
}

components/schemas/QuotaProblem

json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Problem"
    },
    {
      "type": "object",
      "properties": {
        "used": {
          "type": "number",
          "description": "Current resource usage in the unit defined by the operation"
        },
        "limit": {
          "type": "number",
          "description": "Configured resource limit in the unit defined by the operation"
        },
        "requested": {
          "type": "number",
          "description": "Additional resource amount requested by the operation"
        }
      },
      "required": [
        "used",
        "limit",
        "requested"
      ]
    }
  ]
}

Operation contract

json
{
  "operationId": "createUpload",
  "tags": [
    "projects/Uploads/Project Uploads"
  ],
  "summary": "Create upload",
  "description": "Create a pending upload at a project path and return the signed URL and headers for the PUT request that sends the bytes. Requires project.uploads.write.",
  "parameters": [
    {
      "$ref": "#/components/parameters/ProjectReference"
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "path": {
              "type": "string",
              "description": "Project-relative path where the upload is stored."
            },
            "file_path": {
              "type": "string",
              "description": "Another spelling of path. Send one of the two."
            },
            "content_type": {
              "type": "string",
              "description": "MIME type of the file"
            },
            "size_bytes": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991,
              "description": "File size in bytes (required for quota tracking)."
            },
            "size": {
              "type": "integer",
              "exclusiveMinimum": 0,
              "maximum": 9007199254740991,
              "description": "Another spelling of size_bytes. Send one of the two."
            }
          }
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Signed upload URL created.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "upload_url": {
                "type": "string",
                "description": "Temporary cloud-storage URL for the upload PUT request."
              },
              "path": {
                "type": "string",
                "description": "Project-relative path of the upload."
              },
              "status": {
                "type": "string",
                "enum": [
                  "pending"
                ],
                "description": "Always pending until the bytes are stored."
              },
              "file_upload_url": {
                "type": "string",
                "description": "The same URL as upload_url."
              },
              "file_path": {
                "type": "string",
                "description": "Storage path of the upload, with the project ID prefix."
              },
              "upload_id": {
                "type": "string",
                "description": "UUID of the pending upload record."
              },
              "required_headers": {
                "type": "object",
                "additionalProperties": {
                  "type": "string"
                },
                "description": "Headers that must be included in the PUT request to the upload URL",
                "example": {
                  "Content-Type": "image/png",
                  "x-goog-content-length-range": "0,1048576"
                }
              }
            },
            "required": [
              "upload_url",
              "path",
              "status",
              "file_upload_url",
              "file_path",
              "upload_id",
              "required_headers"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "402": {
      "description": "Payment required",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/QuotaProblem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Not found",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "409": {
      "description": "An upload was created at the same path concurrently",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "500": {
      "description": "Server error",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    }
  },
  "x-documentation-source-tag": "Project Uploads",
  "x-canonical-documentation": {
    "domain": "projects",
    "resource": "Uploads",
    "subgroup": "Project Uploads",
    "name": "Create upload",
    "description": "Create a pending upload at a project path and return the signed URL and headers for the PUT request that sends the bytes. Requires project.uploads.write.",
    "operationId": "createUpload"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/projects-uploads-project-uploads/create-upload"
  }
}