{"id":19511472,"url":"https://github.com/datafog/datafog-api","last_synced_at":"2026-02-01T03:38:38.605Z","repository":{"id":249885753,"uuid":"830642628","full_name":"DataFog/datafog-api","owner":"DataFog","description":"Privacy Engineering for the Generative AI era made available through a REST API","archived":false,"fork":false,"pushed_at":"2024-09-19T12:39:58.000Z","size":64,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"dev","last_synced_at":"2025-06-19T09:48:24.112Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://datafog.ai","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DataFog.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-07-18T17:11:10.000Z","updated_at":"2024-10-30T18:34:50.000Z","dependencies_parsed_at":"2024-11-10T23:23:52.267Z","dependency_job_id":"bdb9775b-a02c-4374-a8a9-4ab6ecfbdc0a","html_url":"https://github.com/DataFog/datafog-api","commit_stats":null,"previous_names":["datafog/datafog-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DataFog/datafog-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataFog%2Fdatafog-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataFog%2Fdatafog-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataFog%2Fdatafog-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataFog%2Fdatafog-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DataFog","download_url":"https://codeload.github.com/DataFog/datafog-api/tar.gz/refs/heads/dev","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DataFog%2Fdatafog-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28966819,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-01T02:14:24.993Z","status":"ssl_error","status_checked_at":"2026-02-01T02:13:55.706Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T23:21:08.134Z","updated_at":"2026-02-01T03:38:38.588Z","avatar_url":"https://github.com/DataFog.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.datafog.ai\"\u003e\u003cimg src=\"https://github.com/DataFog/datafog-python/raw/main/public/colorlogo.png\" alt=\"DataFog logo\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cb\u003eREST API for PII detection and anonymization\u003c/b\u003e. \u003cbr /\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n     \u003ca href=\"https://hub.docker.com/r/datafog/datafog-api\"\u003e\u003cimg src=\"https://img.shields.io/badge/Docker-2CA5E0?style=for-the-badge\u0026logo=docker\u0026logoColor=white\" alt=\"Docker\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://discord.gg/bzDth394R4\"\u003e\u003cimg src=\"https://img.shields.io/discord/1173803135341449227?style=flat\" alt=\"Discord\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://codecov.io/gh/datafog/datafog-api\"\u003e\u003cimg src=\"https://img.shields.io/codecov/c/github/datafog/datafog-api.svg?style=flat-square\" alt=\"codecov\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://github.com/pre-commit/pre-commit\"\u003e\n     \u003cimg src=\"https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\" alt=\"pre-commit\" style=\"max-width:100%;\"\u003e\u003c/a\u003e\n     \u003ca href=\"https://github.com/psf/black\"\u003e\u003cimg src=\"https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square\" alt=\"Code style: black\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## Overview\n\ndatafog-api is a REST API service that lets you detect ('annotate'), and anonymize sensitive information in your data using specialized ML models.\n\n## Getting Started:\n\n### Option 1: Install via Docker (fastest)\n\nThe fastest way to get started with datafog-api is to pull the image from Docker:\n\n```sh\ndocker pull datafog/datafog-api:latest\n```\n\n### Option 2: Build from source\n\nAlternatively, you can clone this repository and build the image locally:\n\n```sh\ngit clone https://github.com/datafog/datafog-api.git\n```\n\n```sh\ncd datafog-api/\ndocker build -t datafog-api .\n```\n\n### Then, run the Docker container\n\n```sh\ndocker run -p 8000:8000  -it datafog-api\n```\n\n\u003e **NOTE** Change the first 8000 to a new port if there is a conflict.\n\n## Documentation\n\nYou can access a user-friendly documentation site by navigating to `127.0.0.1:8000/redoc`\n\n## Example cURL request/responses\n\n### Annotation\n\nRequest:\n\n```sh\ncurl -X POST http://127.0.0.1:8000/api/annotation/default \\\n     -H \"Content-Type: application/json\" \\\n     -d '{\"text\": \"My name is Peter Parker. I live in Queens, NYC. I work at the Daily Bugle.\"}'\n```\n\nResponse:\n\n```sh\n{\n  \"entities\": [\n    {\"text\": \"Peter Parker\", \"start\": 11, \"end\": 23, \"type\": \"PER\"},\n    {\"text\": \"Queens\", \"start\": 35, \"end\": 41, \"type\": \"LOC\"},\n    {\"text\": \"NYC\", \"start\": 43, \"end\": 46, \"type\": \"LOC\"},\n    {\"text\": \"the Daily Bugle\", \"start\": 58, \"end\": 73, \"type\": \"ORG\"}\n  ]\n}\n```\n\n### Anonymization (One-way)\n\nRequest:\n\n```sh\ncurl -X POST http://127.0.0.1:8000/api/anonymize/non-reversible \\\n     -H \"Content-Type: application/json\" \\\n     -d '{\"text\": \"My name is Peter Parker. I live in Queens, NYC. I work at the Daily Bugle.\"}'\n```\n\nResponse:\n\n```sh\n{\n  \"text\": \"My name is [PER]. I live in [LOC], [LOC]. I work at [ORG].\",\n  \"entities\": [\n    {\"text\": \"Peter Parker\", \"start\": 11, \"end\": 23, \"type\": \"PER\"},\n    {\"text\": \"Queens\", \"start\": 35, \"end\": 41, \"type\": \"LOC\"},\n    {\"text\": \"NYC\", \"start\": 43, \"end\": 46, \"type\": \"LOC\"},\n    {\"text\": \"the Daily Bugle\", \"start\": 58, \"end\": 73, \"type\": \"ORG\"}\n  ]\n}\n```\n\n### Anonymization (Reversible)\n\nComing soon!\n\n## Advanced\n\n### Local Development\n\n```sh\ngit clone https://github.com/datafog/datafog-api.git\ncd datafog-api/\npython -m venv myenv\nsource myenv/bin/activate\ncd app\npip install -r requirements-dev.txt\nuvicorn main:app\n```\n\n\u003e **NOTE** datafog-api requires Python 3.11+. If you require support for other versions, please email us at hi@datafog.ai.\n\n### Contributors\n\n- sroy9675\n- pselvana\n- sidmohan0\n\n# License\n\nThis software is published under the [MIT\nlicense](https://en.wikipedia.org/wiki/MIT_License).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatafog%2Fdatafog-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatafog%2Fdatafog-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatafog%2Fdatafog-api/lists"}