---
title: "Detect framework and build settings of an upload from its file list (contents only for package.json and build configuration files)"
method: POST
path: "/detect/files"
tags: ["Projects"]
---

# Detect framework and build settings of an upload from its file list (contents only for package.json and build configuration files)

`POST /detect/files`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/detect/files`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Request body

- object
  - `files` object[], required
    - `path` string, required: relative path inside the upload, "/" separated
    - `content` string: only for package.json and build configuration files (DETECT_CONTENT_FILES)
  - `rootDirectory` string

## Response `200`

Detected settings

- object
  - `build` object, required
    - `framework` 'nextjs' | 'vite' | 'astro' | 'remix' | 'nuxt' | 'sveltekit' | 'gatsby' | 'create-react-app' | 'angular' | 'vue' | 'svelte' | 'hugo' | 'docusaurus' | 'static' | 'node' | 'express' | 'nestjs' | 'fastify' | 'hono' | 'python' | 'php' | 'docker' | 'wordpress' | 'other', required
    - `buildPack` 'nixpacks' | 'railpack' | 'static' | 'dockerfile' | 'dockerimage' | 'service', required
    - `rootDirectory` string, required: "/" or a sub-path
    - `installCommand` string, nullable, required
    - `buildCommand` string, nullable, required
    - `startCommand` string, nullable, required
    - `outputDirectory` string, nullable, required: static output, e.g. dist or out
    - `port` integer, nullable, required
    - `nodeVersion` string, nullable, required
  - `confidence` 'high' | 'medium' | 'low', required
  - `notes` string[], required

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state (code conflict)
- `429`: Too many requests (code rate_limited); see Retry-After
- `503`: Hosting engine unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)