{"id":13570089,"url":"https://github.com/roboflow/roboflow-node","last_synced_at":"2025-05-05T14:31:28.705Z","repository":{"id":60860898,"uuid":"259745128","full_name":"roboflow/roboflow-node","owner":"roboflow","description":"Roboflow CLI and API module for node","archived":false,"fork":false,"pushed_at":"2024-03-14T18:48:42.000Z","size":915,"stargazers_count":5,"open_issues_count":4,"forks_count":2,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-05-04T23:52:19.709Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://roboflow.com","language":"JavaScript","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/roboflow.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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}},"created_at":"2020-04-28T20:32:33.000Z","updated_at":"2024-08-14T22:43:26.000Z","dependencies_parsed_at":"2024-01-14T03:50:25.683Z","dependency_job_id":"baa774f4-80dc-4099-a6ea-c04271dbb8cb","html_url":"https://github.com/roboflow/roboflow-node","commit_stats":null,"previous_names":["roboflow-ai/roboflow-node"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roboflow%2Froboflow-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roboflow%2Froboflow-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roboflow%2Froboflow-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roboflow%2Froboflow-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roboflow","download_url":"https://codeload.github.com/roboflow/roboflow-node/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252416496,"owners_count":21744448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-08-01T14:00:48.117Z","updated_at":"2025-05-05T14:31:28.446Z","avatar_url":"https://github.com/roboflow.png","language":"JavaScript","funding_links":[],"categories":["Specialised APIs"],"sub_categories":[],"readme":"# Roboflow node library\n\nRoboflow makes computer vision accessible to all developers.\n[https://roboflow.com](https://roboflow.com)\n\n**This project is under active development, use at your own risk**\n\n## Node Module\n\nThe node module is currently a very basic wrapper around roboflow API endpoints.\n\nYou can use it like so:\n\n```\nconst roboflow = require(\"roboflow\");\nconst workspaceInfo = roboflow.getWorkspace(workspaceUrl, apiKey);\n```\n\nIt currently includes the following functions, which are implemented in [api.js](api.js):\n\n-   `getWorkspace(workspaceUrl, apiKey)`\n-   `getProject(workspaceUrl, projectUrl, apiKey)`\n-   `getVersion(workspaceUrl, projectUrl, version, apiKey)`\n-   `getFormat(workspaceUrl, projectUrl, version, format, apiKey)`\n-   `uploadImage(filepath, projectUrl, apiKey, options)`\n-   `detectObject(filepath, modelUrl, apiKey, options)`\n-   `classify(filepath, modelUrl, apiKey)`\n-   `instanceSegmentation(filepath, modelUrl, apiKey)`\n-   `semanticSegmentation(filepath, modelUrl, apiKey)`\n-   `embedImage(filepath, apiKey)`\n-   `embedText(text, apiKey)`\n\n## Development\n### Testing\nThe repo includes a series of `jest` tests to make sure the api wrapper functions work as expected. To run the tests you must setup a `.env` file with the following variables and run `npm run test`:\n-   `apiKey` a valid roboflow api key\n-   `workspace` a valid roboflow workspace which can be accessed with the given `apiKey`\n-   `project` a valid roboflow project within the given `workspace`\n-   `version` a valid version of the given roboflow project which has a model trained\n-   `testImage` the relative path to a test image inside the `__tests__` directory such as `test.jpeg`","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froboflow%2Froboflow-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froboflow%2Froboflow-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froboflow%2Froboflow-node/lists"}