Get files

http
POST /projects/{project_reference}/files/batch

Return the files at the given paths. Requires project.read.

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.
refqueryNo
branchqueryNo
branch_idqueryNo

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"
  },
  {
    "schema": {
      "type": "string",
      "description": "Content to address: `main`, `branch:<name-or-id>`, `release:<version>` or `env:<name>`. Canonical replacement for `branch` and `branch_id`.",
      "example": "branch:feature-x"
    },
    "required": false,
    "name": "ref",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "description": "Branch name or ID. Legacy alias for `ref=branch:<value>`.",
      "example": "feature-x"
    },
    "required": false,
    "name": "branch",
    "in": "query"
  },
  {
    "schema": {
      "type": "string",
      "format": "uuid",
      "description": "Branch ID. Legacy alias for `ref=branch:<uuid>`."
    },
    "required": false,
    "name": "branch_id",
    "in": "query"
  }
]

Request body

json
{
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "paths": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Array of file paths to fetch"
          }
        },
        "required": [
          "paths"
        ]
      }
    }
  }
}

Responses

200

Files with content.

json
{
  "description": "Files with content.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "files": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string",
                  "description": "The requested path, or the stored path of the file it resolved to."
                },
                "type": {
                  "type": "string",
                  "description": "File type. A server function the caller may not read is reported as `function`."
                },
                "content": {
                  "type": "string",
                  "description": "File content. Empty when the file is not found or not readable."
                },
                "size": {
                  "type": "number",
                  "description": "Size of the file content encoded as UTF-8, in bytes."
                },
                "found": {
                  "type": "boolean",
                  "description": "Whether the file was found and is readable by the caller."
                },
                "binary": {
                  "type": "object",
                  "properties": {
                    "content_hash": {
                      "type": "string",
                      "pattern": "^[a-f0-9]{64}$"
                    },
                    "byte_size": {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 8388608
                    },
                    "content_type": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200,
                      "pattern": "^[\\x20-\\x7e]+$"
                    }
                  },
                  "required": [
                    "content_hash",
                    "byte_size",
                    "content_type"
                  ],
                  "additionalProperties": false
                },
                "checksum": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "error": {
                  "type": "string",
                  "description": "Why the read of this path failed, when it failed."
                }
              },
              "required": [
                "path",
                "type",
                "content",
                "size",
                "found"
              ]
            }
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "path": {
                  "type": "string",
                  "description": "The requested path, or the stored path of the file it resolved to."
                },
                "found": {
                  "type": "boolean",
                  "description": "False for a path that names no file or a file the caller may not read."
                },
                "file": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "id": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "File ID, or null when the content source supplies none."
                    },
                    "version_id": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Current version ID, or null when the content source supplies none."
                    },
                    "path": {
                      "type": "string",
                      "description": "Project-relative source path."
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "page",
                        "function",
                        "component",
                        "file"
                      ],
                      "description": "File kind: page, function, component or file."
                    },
                    "content": {
                      "type": "string",
                      "description": "Full text content."
                    },
                    "size_bytes": {
                      "type": "number",
                      "description": "Size of the content encoded as UTF-8, in bytes."
                    },
                    "binary": {
                      "type": "object",
                      "properties": {
                        "content_hash": {
                          "type": "string",
                          "pattern": "^[a-f0-9]{64}$"
                        },
                        "byte_size": {
                          "type": "integer",
                          "minimum": 0,
                          "maximum": 8388608
                        },
                        "content_type": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 200,
                          "pattern": "^[\\x20-\\x7e]+$"
                        }
                      },
                      "required": [
                        "content_hash",
                        "byte_size",
                        "content_type"
                      ],
                      "additionalProperties": false
                    },
                    "checksum": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "SHA-256 content hash, or null when unavailable."
                    },
                    "updated_at": {
                      "type": "string",
                      "description": "Last content update time, RFC 3339."
                    }
                  },
                  "required": [
                    "id",
                    "version_id",
                    "path",
                    "type",
                    "content",
                    "size_bytes",
                    "checksum",
                    "updated_at"
                  ],
                  "description": "The file, or null when found is false."
                },
                "error": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "properties": {
                    "code": {
                      "type": "string",
                      "enum": [
                        "internal"
                      ],
                      "description": "Always internal: the read of this path failed."
                    },
                    "message": {
                      "type": "string",
                      "description": "Why the read of this path failed."
                    }
                  },
                  "required": [
                    "code",
                    "message"
                  ],
                  "description": "Set only when the read of this path failed; null for a missing or restricted path."
                }
              },
              "required": [
                "path",
                "found",
                "file",
                "error"
              ]
            },
            "description": "The same entries in the canonical shape: the file, or found false, with error set only for a failed read."
          }
        },
        "required": [
          "files",
          "data"
        ]
      }
    }
  }
}

400

Invalid input, or an invalid or conflicting content selector

json
{
  "description": "Invalid input, or an invalid or conflicting content selector",
  "content": {
    "application/problem+json": {
      "schema": {
        "$ref": "#/components/schemas/Problem"
      }
    }
  }
}

401

Unauthorized

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

403

Forbidden - insufficient permissions

json
{
  "description": "Forbidden - insufficient permissions",
  "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"
      }
    }
  }
}

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"
  ]
}

Operation contract

json
{
  "operationId": "getFiles",
  "tags": [
    "projects/Files/Files"
  ],
  "summary": "Get files",
  "description": "Return the files at the given paths. Requires project.read.",
  "parameters": [
    {
      "$ref": "#/components/parameters/ProjectReference"
    },
    {
      "schema": {
        "type": "string",
        "description": "Content to address: `main`, `branch:<name-or-id>`, `release:<version>` or `env:<name>`. Canonical replacement for `branch` and `branch_id`.",
        "example": "branch:feature-x"
      },
      "required": false,
      "name": "ref",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "description": "Branch name or ID. Legacy alias for `ref=branch:<value>`.",
        "example": "feature-x"
      },
      "required": false,
      "name": "branch",
      "in": "query"
    },
    {
      "schema": {
        "type": "string",
        "format": "uuid",
        "description": "Branch ID. Legacy alias for `ref=branch:<uuid>`."
      },
      "required": false,
      "name": "branch_id",
      "in": "query"
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "paths": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Array of file paths to fetch"
            }
          },
          "required": [
            "paths"
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Files with content.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "files": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "type": "string",
                      "description": "The requested path, or the stored path of the file it resolved to."
                    },
                    "type": {
                      "type": "string",
                      "description": "File type. A server function the caller may not read is reported as `function`."
                    },
                    "content": {
                      "type": "string",
                      "description": "File content. Empty when the file is not found or not readable."
                    },
                    "size": {
                      "type": "number",
                      "description": "Size of the file content encoded as UTF-8, in bytes."
                    },
                    "found": {
                      "type": "boolean",
                      "description": "Whether the file was found and is readable by the caller."
                    },
                    "binary": {
                      "type": "object",
                      "properties": {
                        "content_hash": {
                          "type": "string",
                          "pattern": "^[a-f0-9]{64}$"
                        },
                        "byte_size": {
                          "type": "integer",
                          "minimum": 0,
                          "maximum": 8388608
                        },
                        "content_type": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 200,
                          "pattern": "^[\\x20-\\x7e]+$"
                        }
                      },
                      "required": [
                        "content_hash",
                        "byte_size",
                        "content_type"
                      ],
                      "additionalProperties": false
                    },
                    "checksum": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "error": {
                      "type": "string",
                      "description": "Why the read of this path failed, when it failed."
                    }
                  },
                  "required": [
                    "path",
                    "type",
                    "content",
                    "size",
                    "found"
                  ]
                }
              },
              "data": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "path": {
                      "type": "string",
                      "description": "The requested path, or the stored path of the file it resolved to."
                    },
                    "found": {
                      "type": "boolean",
                      "description": "False for a path that names no file or a file the caller may not read."
                    },
                    "file": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "properties": {
                        "id": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "description": "File ID, or null when the content source supplies none."
                        },
                        "version_id": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "description": "Current version ID, or null when the content source supplies none."
                        },
                        "path": {
                          "type": "string",
                          "description": "Project-relative source path."
                        },
                        "type": {
                          "type": "string",
                          "enum": [
                            "page",
                            "function",
                            "component",
                            "file"
                          ],
                          "description": "File kind: page, function, component or file."
                        },
                        "content": {
                          "type": "string",
                          "description": "Full text content."
                        },
                        "size_bytes": {
                          "type": "number",
                          "description": "Size of the content encoded as UTF-8, in bytes."
                        },
                        "binary": {
                          "type": "object",
                          "properties": {
                            "content_hash": {
                              "type": "string",
                              "pattern": "^[a-f0-9]{64}$"
                            },
                            "byte_size": {
                              "type": "integer",
                              "minimum": 0,
                              "maximum": 8388608
                            },
                            "content_type": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 200,
                              "pattern": "^[\\x20-\\x7e]+$"
                            }
                          },
                          "required": [
                            "content_hash",
                            "byte_size",
                            "content_type"
                          ],
                          "additionalProperties": false
                        },
                        "checksum": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "description": "SHA-256 content hash, or null when unavailable."
                        },
                        "updated_at": {
                          "type": "string",
                          "description": "Last content update time, RFC 3339."
                        }
                      },
                      "required": [
                        "id",
                        "version_id",
                        "path",
                        "type",
                        "content",
                        "size_bytes",
                        "checksum",
                        "updated_at"
                      ],
                      "description": "The file, or null when found is false."
                    },
                    "error": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "properties": {
                        "code": {
                          "type": "string",
                          "enum": [
                            "internal"
                          ],
                          "description": "Always internal: the read of this path failed."
                        },
                        "message": {
                          "type": "string",
                          "description": "Why the read of this path failed."
                        }
                      },
                      "required": [
                        "code",
                        "message"
                      ],
                      "description": "Set only when the read of this path failed; null for a missing or restricted path."
                    }
                  },
                  "required": [
                    "path",
                    "found",
                    "file",
                    "error"
                  ]
                },
                "description": "The same entries in the canonical shape: the file, or found false, with error set only for a failed read."
              }
            },
            "required": [
              "files",
              "data"
            ]
          }
        }
      }
    },
    "400": {
      "description": "Invalid input, or an invalid or conflicting content selector",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "403": {
      "description": "Forbidden - insufficient permissions",
      "content": {
        "application/problem+json": {
          "schema": {
            "$ref": "#/components/schemas/Problem"
          }
        }
      }
    },
    "404": {
      "description": "Not found",
      "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 Files",
  "x-canonical-documentation": {
    "domain": "projects",
    "resource": "Files",
    "subgroup": "Files",
    "name": "Get files",
    "description": "Return the files at the given paths. Requires project.read.",
    "operationId": "getFiles"
  },
  "x-mint": {
    "href": "/cloud/rest/api-reference/projects-files-files/get-files"
  }
}