---
title: "POST /api/files/file_details"
method: POST
path: "/api/files/file_details"
---

# POST /api/files/file_details

`POST /api/files/file_details`

## Request body

- FileDetailsRequest
  - `maxBytes` integer, nullable
  - `path` string, required

## Response `200`

Get details of a specific file or directory

- FileDetailsResponse
  - `contents` string, nullable
  - `file` FileInfo, required
    - `children` FileInfo[]
    - `id` string, required
    - `isDirectory` boolean, required
    - `isMarimoFile` boolean, required
    - `lastModified` number, nullable
    - `name` string, required
    - `opengraph` OpenGraphMetadata — OpenGraph-style metadata for a notebook. The `image` field may be either: - a relative path (typically under `__marimo__/`), or - an absolute HTTPS URL.
      - `description` string, nullable
      - `image` string, nullable
      - `title` string, nullable
    - `path` string, required
    - `size` integer, nullable
  - `isBase64` boolean
  - `isTooLarge` boolean
  - `mimeType` string, nullable

## Changes

> 60 revisions in range; 3 could not be searched.

- **2026-07-24** `a6054d54dad6` — 3 info
  - added the new optional request property `maxBytes`
  - added the optional property `file/size` to the response with the `200` status
  - added the optional property `isTooLarge` to the response with the `200` status
- **2026-03-26** `ae3e8152eb99` — 1 info
  - added the optional property `isBase64` to the response with the `200` status
- **2026-03-18** `f29fa637d35b` — 1 warning
  - removed the optional property `isBase64` from the response with the `200` status

[Change history](https://skmtc.dev/marimo-team/apis/marimo-api/changes/api/files/file_details/post.md)

---

[API](https://skmtc.dev/marimo-team/apis/marimo-api.md) · [All operations](https://skmtc.dev/marimo-team/apis/marimo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/marimo-team/marimo-api/revisions/a39082aac3ce/schema)