---
agentTools:
  projectIndex: https://sched.readme.io/llms.txt
---

# Files

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "sched.dev",
    "description": "Scheduling API",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.sched.dev",
      "description": "API Server"
    },
    {
      "url": "https://sandbox-api.sched.dev",
      "description": "Sandbox API Server"
    }
  ],
  "paths": {
    "/v1/files": {
      "get": {
        "tags": [
          "Files"
        ],
        "summary": "Files",
        "operationId": "files_v1_files_get",
        "parameters": [
          {
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "title": "Skip",
              "default": 0
            },
            "name": "skip",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "title": "Limit",
              "default": 50
            },
            "name": "limit",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "string",
              "title": "Sort Field",
              "default": "created_at"
            },
            "name": "sort_field",
            "in": "query"
          },
          {
            "required": false,
            "schema": {
              "type": "string",
              "title": "Sort Order",
              "default": "desc"
            },
            "name": "sort_order",
            "in": "query"
          }
        ],
        "responses": {
          "200": {
            "description": "List all file instances",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/IGetResponseBase_List_src.schemas.file.IFileRead__"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        },
        "security": [
          {
            "OAuth2ClientCredentialsBearer": [
              "files:read"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "IFileRead": {
        "properties": {
          "name": {
            "type": "string",
            "title": "Name",
            "description": "The name of the file"
          },
          "description": {
            "type": "string",
            "title": "Description",
            "description": "The description of the file"
          },
          "mime_type": {
            "type": "string",
            "title": "Mime Type",
            "description": "The MIME type of the file"
          },
          "s3_bucket": {
            "type": "string",
            "title": "S3 Bucket",
            "description": "The S3 bucket of the file"
          },
          "s3_key": {
            "type": "string",
            "title": "S3 Key",
            "description": "The S3 key of the file"
          },
          "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
          },
          "url": {
            "type": "string",
            "title": "Url"
          }
        },
        "type": "object",
        "required": [
          "name",
          "id"
        ],
        "title": "IFileRead"
      },
      "IGetResponseBase_List_src.schemas.file.IFileRead__": {
        "properties": {
          "message": {
            "type": "string",
            "title": "Message",
            "default": "Data got correctly"
          },
          "meta": {
            "type": "object",
            "title": "Meta",
            "default": {}
          },
          "data": {
            "items": {
              "$ref": "#/components/schemas/IFileRead"
            },
            "type": "array",
            "title": "Data"
          }
        },
        "type": "object",
        "title": "IGetResponseBase[List[src.schemas.file.IFileRead]]"
      },
      "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": {
      "OAuth2ClientCredentialsBearer": {
        "type": "oauth2",
        "flows": {
          "password": {
            "scopes": {},
            "tokenUrl": "/v1/auth/token"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 103,
      "1": 14,
      "2": 106,
      "3": 94,
      "4": 33,
      "5": 109,
      "6": 146,
      "7": 0,
      "8": 49,
      "9": 64,
      "10": 212,
      "11": 226
    }
  }
}
```