{"id":15136590,"url":"https://github.com/appwrite/assistant","last_synced_at":"2025-04-09T16:08:23.101Z","repository":{"id":186503624,"uuid":"642775550","full_name":"appwrite/assistant","owner":"appwrite","description":"Appwrite's AI assistant 🧠 ","archived":false,"fork":false,"pushed_at":"2025-02-04T11:24:35.000Z","size":372,"stargazers_count":54,"open_issues_count":2,"forks_count":16,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-04-09T16:08:12.347Z","etag":null,"topics":["ai","appwrite","backend-as-a-service","openai"],"latest_commit_sha":null,"homepage":"https://appwrite.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/appwrite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"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":"2023-05-19T10:14:39.000Z","updated_at":"2025-04-09T11:02:52.000Z","dependencies_parsed_at":"2024-02-26T11:51:45.597Z","dependency_job_id":"b687fcd0-b0ee-41b1-93b8-9a23a452f37e","html_url":"https://github.com/appwrite/assistant","commit_stats":{"total_commits":61,"total_committers":8,"mean_commits":7.625,"dds":0.6229508196721312,"last_synced_commit":"43d1b3e952443d8aa5b38b9751609768668e8436"},"previous_names":["appwrite/assistant"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fassistant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fassistant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fassistant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/appwrite%2Fassistant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/appwrite","download_url":"https://codeload.github.com/appwrite/assistant/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248065285,"owners_count":21041871,"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":["ai","appwrite","backend-as-a-service","openai"],"created_at":"2024-09-26T06:23:33.783Z","updated_at":"2025-04-09T16:08:23.081Z","avatar_url":"https://github.com/appwrite.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Assistant ✨\n\n[![Discord](https://img.shields.io/discord/564160730845151244?label=discord\u0026style=flat-square)](https://appwrite.io/discord)\n[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee\u0026label=twitter\u0026style=flat-square)](https://twitter.com/appwrite)\n[![appwrite.io](https://img.shields.io/badge/appwrite-.io-f02e65?style=flat-square)](https://appwrite.io)\n\nAppwrite Assistant is an AI-powered API that helps you with Appwrite-related tasks, powered by the official Appwrite documentation.\n\n## Installation\n\nMake sure you have [pnpm](https://pnpm.io/) installed.\n\nTo install, run the following command.\n\n```bash\npnpm i\n```\n\nNext, fetch the Appwrite-specific sources used by the assistant. This will download the sources from the Appwrite documentation and store them in the `./sources` directory.\n\n```bash\npnpm run fetch-sources\n```\n\nThe scripts will pull the latest documentation from the `main` branch of the [website repository](https://github.com/appwrite/website), and the latest API reference from live [Appwrite documentation](https://appwrite.io/docs). \n\nIf you want to pull from a different branch or repository, you can set the `_BUILD_GIT_URL` and `_BUILD_WEBSITE_URL` environment variables.\n\n## Usage\n\nFirst, retrieve an API key from OpenAI. You can sign up for an API key at [OpenAI](https://beta.openai.com/signup/). Once you have an API key, set it as the `_APP_ASSISTANT_OPENAI_API_KEY` environment variable.\n\nTo run the server, execute the `dev` command. By default, the server will be available at `http://localhost:3003` \n\n```bash\npnpm run dev\n```\n\nThe server exposes a POST endpoint at `/`. The endpoint expects a raw text body containing the query for the assistant. The answer to the query will be streamed back to the client as raw text.\n\nUse cURL to test the server, for example:\n\n```bash\ncurl -X POST -H \"Content-Type: application/json\" -d \"{\\\"prompt\\\": \\\"How do I create a new user?\\\"}\" http://localhost:3003/v1/models/assistant/prompt\n```\n\n## Contributing\n\nAll code contributions, including those of people having commit access, must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.\n\nWe truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fassistant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fappwrite%2Fassistant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fappwrite%2Fassistant/lists"}