> ## 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 file system > Retrieves detailed information about a specific file system, including its quota and external access configuration. ## OpenAPI ````yaml get /v2/file-systems/{file_system_key} openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://my.orq.ai security: - ApiKey: [] tags: - name: Chunking description: Split text into smaller chunks for retrieval and generation workflows. - name: File Systems description: >- Create and manage persistent file systems that agents and MCP clients read from and write to. - name: Knowledge Bases description: Create and manage knowledge bases used by agents and retrieval workflows. - name: Memory Stores description: Create and manage memory stores, memories, and memory documents. - name: Evals description: Run an evaluator against a conversation and its result - name: Logs description: >- OpenTelemetry log query API. Search, filter, aggregate, and facet log records ingested via OTLP. - 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. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. - description: List models available through the AI Router. name: Models - name: Policies - name: Alerts description: >- Alerts evaluate a Reporting API metric on a fixed interval and fire notifications through notifiers when the value breaches a threshold. Each breach opens a trigger that tracks the incident until the value recovers. - name: Annotation Queues description: Annotation queues collect spans for human review. - name: API keys description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. - name: Audit Logs description: Audit logs record workspace entity changes and access-relevant events. - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, API key, provider, and model. Every applicable budget is enforced, and the most restrictive limit applies per dimension. - name: Files description: File upload and retrieval operations. - name: Guardrail Rules description: >- Guardrail Rules conditionally enforce evaluators and plugins for AI Gateway traffic. Rules may be scoped to a project or the whole workspace. - name: Hub description: Hub items are reusable templates available to a workspace. - name: Identities description: >- Identities represent end users from your system for usage and engagement tracking. - name: Management keys description: >- Management keys are workspace-scoped credentials that authenticate programmatic access to workspace administration surfaces (API keys, budgets). Unlike project-scoped API keys, a management key always operates at the workspace level. - name: MCP Gateway description: >- Register upstream MCP servers, discover and sync their tools, and assemble gateways that expose a curated tool surface to MCP clients. - name: Model Catalog description: >- Browse the orq.ai model catalog: every model orq offers, across every provider, with pricing, capabilities and benchmark data. List endpoints only return models that are not deprecated. This API is public, requires no authentication, and is rate limited to 120 requests per minute per IP. Responses carry a 5-minute cache-control max-age. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Projects description: Projects organize resources within a workspace - name: Routing Rules description: >- Routing Rules conditionally select models and enforce request plugins for AI Gateway traffic. Rules are evaluated by ascending priority and may be scoped to a project or the whole workspace. - name: Threads description: Threads group related trace invocations and their aggregate usage - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: Smart Routers description: >- Create and manage workspace Smart Routers. A Smart Router selects a model from an eligible pool for each request according to a quality, balanced, or cost profile. - name: Webhooks description: >- Create and manage webhooks that deliver workspace events to external HTTPS endpoints. - name: Workspaces description: >- A workspace is the tenant. Create is a user-session onboarding RPC; Get, List, and Update are the public management surface. - name: Workspace Security description: >- Workspace-level domain verification and IP allowlist controls. These operations are restricted to workspace administrators. - name: Workspace Settings description: >- Workspace-level settings managed with a workspace credential. A workspace is the tenant, so these settings are a singleton — there is nothing to create or delete, only read and update. - name: Responses - description: Run agents on a cron cadence. Minimum firing interval is 1 hour. name: Agent Schedules - name: Embeddings - name: Telemetry description: >- Unified query envelope for traces, metrics, and logs (ADR 0004). One request shape, one filter dialect, and one response shape per source, validated by a per-source registry. externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/file-systems/{file_system_key}: get: tags: - File Systems summary: Retrieve file system description: >- Retrieves detailed information about a specific file system, including its quota and external access configuration. operationId: RetrieveFileSystem parameters: - name: file_system_key in: path required: true schema: type: string responses: '200': description: File system details successfully retrieved. content: application/json: schema: $ref: '#/components/schemas/FileSystem' '404': description: File system not found. components: schemas: FileSystem: required: - _id - key - display_name - description - project_id - external_access - created - updated type: object properties: id: type: string description: The unique identifier of the file system key: maxLength: 255 minLength: 1 pattern: ^[A-Za-z]([A-Za-z0-9]*([._][A-Za-z0-9]+)*)?$ type: string description: >- The unique key of the file system. The key is unique and immutable and cannot be repeated within the same workspace. display_name: type: string description: Human readable name shown in the UI description: type: string description: >- The description of the file system. Be as precise as possible to help the AI understand what the file system is for. project_id: type: string description: Identifier of the project the file system belongs to external_access: $ref: '#/components/schemas/FileSystemExternalAccess' description: >- Whether external MCP clients may reach this file system, and with which access created_by_id: type: - string - 'null' description: The user ID of the creator updated_by_id: type: - string - 'null' description: The user ID of the last updater created: type: string description: The creation date of the file system updated: type: string description: The last update date of the file system sharing: $ref: '#/components/schemas/Sharing' used_bytes: type: - string - 'null' description: >- Apparent size of the file system in bytes at the last metering. Absent until first metered. used_inodes: type: - string - 'null' description: >- Number of files and directories in the file system at the last metering. Absent until first metered. last_metered_at: type: - string - 'null' description: When usage was last measured. Absent until first metered. FileSystemExternalAccess: type: string enum: - disabled - read_only - read_write Sharing: type: object properties: all_projects: allOf: - $ref: '#/components/schemas/SharingAllProjects' description: Visible to every project in the workspace. selected: allOf: - $ref: '#/components/schemas/SharingSelectedProjects' description: Visible to the listed projects only. allow_version_pin: type: boolean description: |- Consuming projects may pin a specific version instead of tracking latest. Enforcement lives with the consuming reference. allow_fork: type: boolean description: |- Projects may duplicate this entity into a detached project-owned copy. auto_grant_new_projects: type: boolean description: |- New projects created after this sharing config is applied should receive access automatically. Enforcement lives with project creation and entity-specific adoption code. description: |- Sharing controls which projects in the workspace may use this entity and what they may do with it. SharingAllProjects: type: object properties: {} SharingSelectedProjects: type: object properties: project_ids: type: array items: type: string description: >- Projects allowed to use the entity. An empty list shares it with no project. securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ````