Skip to main content
GET
/
file-storage
/
{projectId}
/
project
curl -X GET \
  "https://bouncer.nunu.ai/file-storage/my-project/project?include_metadata=true" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "projectId": "my-project",
  "scope": "project",
  "count": 2,
  "files": [
    {
      "filename": "game-design.md",
      "path": "game-design.md",
      "size": 4096,
      "uploaded": "2026-04-12T10:30:00.000Z",
      "etag": "9a3b4c5d6e7f8090a1b2c3d4e5f60718",
      "metadata": {
        "description": "High-level design overview",
        "summary": "Mechanics, levels, and progression",
        "keywords": ["design", "gameplay"]
      }
    },
    {
      "filename": "rules.txt",
      "path": "subdir/rules.txt",
      "size": 1234,
      "uploaded": "2026-04-12T10:31:00.000Z",
      "etag": "0a1b2c3d4e5f60718a3b4c5d6e7f8090"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.nunu.ai/llms.txt

Use this file to discover all available pages before exploring further.

Permission Required: any API key scoped to the requested project
Knowledge endpoints are served by the bouncer service at https://bouncer.nunu.ai, not the main nunu.ai/api/v1 host. Use the same X-Api-Key header for authentication.
Returns only the files stored under the project’s project/ prefix. These are the files that every run in the project sees regardless of which agent or test case it executes. If you instead want a single response that combines project files with agent- or test-case-scoped files, use List Knowledge Files.

​
Path Parameters

​
projectId
string
required
The nunu.ai project ID. Must match the project the API key is scoped to.

​
Query Parameters

​
include_metadata
boolean
default:"false"
When true, attach parsed metadata (description, summary, keywords) for each file from its .{name}.meta.json sidecar.

​
Response

​
projectId
string
required
Echo of the path parameter.
​
scope
string
required
Always "project" for this endpoint.
​
count
integer
required
Number of files returned.
​
files
File[]
required
Files in the project scope.
curl -X GET \
  "https://bouncer.nunu.ai/file-storage/my-project/project?include_metadata=true" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "projectId": "my-project",
  "scope": "project",
  "count": 2,
  "files": [
    {
      "filename": "game-design.md",
      "path": "game-design.md",
      "size": 4096,
      "uploaded": "2026-04-12T10:30:00.000Z",
      "etag": "9a3b4c5d6e7f8090a1b2c3d4e5f60718",
      "metadata": {
        "description": "High-level design overview",
        "summary": "Mechanics, levels, and progression",
        "keywords": ["design", "gameplay"]
      }
    },
    {
      "filename": "rules.txt",
      "path": "subdir/rules.txt",
      "size": 1234,
      "uploaded": "2026-04-12T10:31:00.000Z",
      "etag": "0a1b2c3d4e5f60718a3b4c5d6e7f8090"
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication

Path Parameters

​
projectId
string
required

The nunu.ai project ID. Must match the project the API key is scoped to.

Query Parameters

​
include_metadata
boolean
default:false

When true, attach parsed metadata (description, summary, keywords) for each file from its .{name}.meta.json sidecar.

Response

Successful response

​
projectId
string
required
​
scope
enum<string>
required
Available options:
project
​
count
integer
required
​
files
object[]
required