> ## Documentation Index
> Fetch the complete documentation index at: https://friendli.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get File Info

> Retrieve metadata for a file stored in Friendli Suite by file ID via the API. Returns filename, size, upload status, and creation timestamp.

Get file info.

To request successfully, it is required to enter a **Personal API Key** (e.g. flp\_XXX) in the **Bearer Token** field.
Refer to the [authentication section](/openapi/introduction#authentication) on our introduction page to learn more and [visit here](https://friendli.ai/suite/~/setting/keys) to generate your API Key.

<Info>
  This API is currently in **Beta**.
  While we strive to provide a stable and reliable experience, this feature is still under active development.
  As a result, you may encounter unexpected behavior or limitations.
  We encourage you to provide feedback to help us improve the feature before its official release.

  * [Feature request & feedback](mailto:support@friendli.ai)
  * [Contact support](mailto:support@friendli.ai)
</Info>


## OpenAPI

````yaml https://github.com/friendliai/friendli-openapi/raw/refs/heads/main/openapi.yaml get /beta/file/{file_id}
openapi: 3.1.0
info:
  title: Friendli Suite API Reference
  description: This is an OpenAPI reference of Friendli Suite API.
  termsOfService: https://friendli.ai/terms-of-service
  contact:
    name: FriendliAI Support Team
    email: support@friendli.ai
  version: 0.1.0
servers:
  - url: https://api.friendli.ai
security: []
tags:
  - name: Serverless.Chat
  - name: Serverless.ToolAssistedChat
  - name: Serverless.Messages
  - name: Serverless.ChatRender
  - name: Serverless.Completions
  - name: Serverless.Token
  - name: Serverless.Audio
  - name: Serverless.Model
  - name: Serverless.Knowledge
  - name: Dedicated.Chat
  - name: Dedicated.Messages
  - name: Dedicated.ChatRender
  - name: Dedicated.Completions
  - name: Dedicated.Embeddings
  - name: Dedicated.TextClassification
  - name: Dedicated.Token
  - name: Dedicated.Image
  - name: Dedicated.Audio
  - name: Dedicated.Endpoint
  - name: Container.Chat
  - name: Container.Messages
  - name: Container.Completions
  - name: Container.TextClassification
  - name: Container.Token
  - name: Container.Image
  - name: Container.Audio
  - name: Cost
  - name: Dataset
  - name: File
paths:
  /beta/file/{file_id}:
    get:
      tags:
        - File
      summary: Get file info
      description: Get file info.
      operationId: get_info
      parameters:
        - name: file_id
          in: path
          required: true
          schema:
            type: string
            description: File ID
            title: File Id
          description: File ID
        - name: X-Friendli-Team
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: ID of team to run requests as (optional parameter).
            title: X-Friendli-Team
          description: ID of team to run requests as (optional parameter).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileInfo'
              examples:
                Example:
                  value:
                    id: file-id
                    name: file-name
                    size: 1024
                    digest: file-digest
                    project_id: project-id
                    creator_id: creator-id
                    created_at: 1705244400
                    expires_at: 1765724399
                    status: UPLOADED
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - token: []
components:
  schemas:
    FileInfo:
      properties:
        id:
          type: string
          title: Id
          description: ID of the file.
        name:
          type: string
          title: Name
          description: Name of the file.
        size:
          type: integer
          title: Size
          description: Size of the file in bytes.
        digest:
          type: string
          title: Digest
          description: SHA256 hash of the file.
        projectId:
          type: string
          title: Projectid
          description: ID of the project the file belongs to.
        creatorId:
          type: string
          title: Creatorid
          description: ID of the creator of the file.
        createdAt:
          type: string
          format: date-time
          title: Createdat
          description: Unix timestamp (in seconds) of when the file was created.
        expiresAt:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expiresat
          description: Unix timestamp (in seconds) of when the file will expire.
        status:
          $ref: '#/components/schemas/AccountFileStatus'
          description: Status of the file upload.
      type: object
      required:
        - id
        - name
        - size
        - digest
        - projectId
        - creatorId
        - createdAt
        - expiresAt
        - status
      title: FileInfo
      description: File information.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AccountFileStatus:
      type: string
      enum:
        - UPLOADING
        - UPLOADED
        - FAILED
        - DELETED
      title: AccountFileStatus
      description: AccountFile status.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    token:
      type: http
      description: >-
        When using Friendli Suite API for inference requests, you need to
        provide a **Personal API Key** for authentication and authorization
        purposes.


        For more detailed information, please refer
        [here](https://friendli.ai/docs/openapi/introduction#authentication).
      scheme: bearer

````