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

# Retrieve a file

> Retrieves the details of an existing file object. After you supply a unique file ID, orq.ai returns the corresponding file object.



## OpenAPI

````yaml get /v2/files/{file_id}
openapi: 3.1.0
info:
  title: orq.ai API
  version: '2.0'
  description: orq.ai API documentation
servers:
  - url: https://api.orq.ai
security:
  - ApiKey: []
tags:
  - description: List models available through the AI Router.
    name: Models
  - name: Guardrail Rules
  - name: Policies
  - name: Routing Rules
  - name: API keys
    description: >-
      API keys authenticate programmatic access to the workspace. The unified
      key model exposes opaque tokens, per-domain access grants, and budget /
      rate-limit constraints (see ADR 0001 and ADR 0002).
  - name: Budgets
    description: >-
      Budgets govern spend, token usage, and request rate across six scopes:
      workspace, project, identity, api-key, provider, and model. A budget is
      hierarchical and defense-in-depth — every applicable budget is a hard
      gate, and the most restrictive one wins per dimension (see ADR 0007).
  - name: Documentation
    description: >-
      Search the orq.ai documentation. Proxies the workspace's query to the
      hosted docs search index.
  - name: Files
    description: File upload and retrieval operations.
  - name: Identities
    description: >-
      Identities represent end users from your system for usage and engagement
      tracking.
  - name: Projects
    description: Projects organize resources within a workspace
  - name: Skills
    description: >-
      Skills are modular instructions you can use to codify processes and
      conventions
  - name: Responses
  - description: >-
      Run agents on a cadence — cron, interval, or one-off. Minimum firing
      interval is 1 hour.
    name: Agent Schedules
  - name: Embeddings
  - name: Reporting
    description: >-
      GenAI reporting API over canonical analytics rollups. Accepts a metric
      name, time range, grain, group-by, and filters; returns a typed time
      series and optional totals.
externalDocs:
  url: https://docs.orq.ai
  description: orq.ai Documentation
paths:
  /v2/files/{file_id}:
    get:
      tags:
        - Files
      summary: Retrieve a file
      description: >-
        Retrieves the details of an existing file object. After you supply a
        unique file ID, orq.ai returns the corresponding file object.
      operationId: FileGet
      parameters:
        - name: file_id
          in: path
          description: File ID to retrieve.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFileResponse'
      x-code-samples:
        - lang: curl
          label: Core - Retrieve file metadata
          source: |
            curl --request GET \
              --url 'https://api.orq.ai/v2/files/file_01HZXW2K7Y8Q9M0N1P2R3S4T5V' \
              --header 'Authorization: Bearer $ORQ_API_KEY'
        - lang: python
          label: Python - Retrieve file metadata
          source: |
            import os
            from orq_ai_sdk import Orq

            client = Orq(api_key=os.environ["ORQ_API_KEY"])

            result = client.files.get(
                file_id="file_01HZXW2K7Y8Q9M0N1P2R3S4T5V",
            )

            print(result.file.file_name)
        - lang: typescript
          label: Node.js - Retrieve file metadata
          source: |
            import { Orq } from '@orq-ai/node';

            const client = new Orq({
              apiKey: process.env.ORQ_API_KEY,
            });

            const result = await client.files.get({
              fileId: 'file_01HZXW2K7Y8Q9M0N1P2R3S4T5V',
            });

            console.log(result.file.fileName);
components:
  schemas:
    GetFileResponse:
      required:
        - file
      type: object
      properties:
        file:
          allOf:
            - $ref: '#/components/schemas/File'
          description: Requested file metadata.
    File:
      required:
        - file_id
        - purpose
        - file_name
        - bytes
        - created_at
        - project_id
      type: object
      properties:
        file_id:
          type: string
          description: Unique file identifier assigned by ORQ.
        purpose:
          $ref: '#/components/schemas/FilePurpose'
          description: Declared usage category for the file.
        file_name:
          type: string
          description: Display file name, including extension when available.
        bytes:
          type: string
          description: Size of the uploaded file in bytes.
        created_at:
          type: string
          description: Time when the file was created.
          format: date-time
        project_id:
          type: string
          description: >-
            Identifier of the project the file belongs to. Files are
            project-scoped; an API key may only access files in projects it is
            authorized for.
    FilePurpose:
      type: string
      enum:
        - FILE_PURPOSE_UNSPECIFIED
        - FILE_PURPOSE_RETRIEVAL
        - FILE_PURPOSE_KNOWLEDGE_DATASOURCE
        - FILE_PURPOSE_BATCH
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````