File

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/datacircle/main/json-schema/datacircle-file-schema.json",
  "title": "File",
  "x-generated": "2026-10-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/datacircle-datacircle-api-openapi.yml#/components/schemas/File",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The file's id: pass it to `POST /files/{file_id}/download-link/`. Every daily file gets a new id. Old ids still download."
    },
    "dataset": {
      "type": "string",
      "enum": [
        "coop_up2data",
        "coop_harvestapi",
        "coop_fetchin"
      ],
      "description": "Which dataset this file is a snapshot of: `coop_up2data`, `coop_harvestapi` and `coop_fetchin` are the co-op files: every LinkedIn profile fetched through Up2Data, through HarvestAPI and through Fetchin, one flat Parquet table each (columns: docs Dataset fields), rebuilt every day. `GET /files/` lists the newest file of each dataset."
    },
    "filename": {
      "type": "string",
      "description": "The download's file name, such as `coop_up2data.parquet`."
    },
    "row_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Rows in the file. `null` when we have not counted it."
    },
    "size_bytes": {
      "type": "integer",
      "description": "The file's size, in bytes."
    },
    "sha256": {
      "type": [
        "string",
        "null"
      ],
      "description": "The file's SHA-256, in hex, to check your download. `null` when we have not measured it."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the file was exported (ISO 8601)."
    },
    "is_unlocked": {
      "type": "boolean",
      "description": "Whether this workspace may download it: `true` once this workspace has added $50 in funds."
    }
  }
}