{"_id":"@aitube/api-client","name":"@aitube/api-client","dist-tags":{"latest":"0.2.4"},"versions":{"0.2.4":{"name":"@aitube/api-client","module":"index.ts","main":"dist/index.js","types":"dist/index.d.ts","type":"module","version":"0.2.4","description":"Official API client for AiTube.at","scripts":{"build":"bun build ./src/index.ts --outfile=dist/index.js --external=@aitube/clap && bun run build:declaration","build:declaration":"tsc --emitDeclarationOnly --project tsconfig.types.json","postbuild":"rimraf tsconfig.types.tsbuildinfo && bun run build:declaration","publish":"npm publish --access public","update":"rm -Rf node_modules && rm bun.lockb && bun i && bun run build"},"devDependencies":{"bun-types":"latest","prettier":"^3.3.3","rimraf":"^6.0.1","typescript":"^5.5.4"},"repository":{"type":"git","url":"git+https://github.com/jbilcke-hf/aitube-client.git"},"keywords":["Clapper.app","AiTube.at","OpenClap","AI cinema","file format","specification"],"author":{"name":"Julian Bilcke"},"license":"MIT","dependencies":{"@aitube/clap":"0.2.4","@types/bun":"latest","query-string":"^9.0.0"},"_id":"@aitube/api-client@0.2.4","gitHead":"4e412a8c7fc4878b5982d706ca54055e64619801","bugs":{"url":"https://github.com/jbilcke-hf/aitube-client/issues"},"homepage":"https://github.com/jbilcke-hf/aitube-client#readme","_nodeVersion":"20.15.1","_npmVersion":"10.7.0","dist":{"integrity":"sha512-1Er+d7tLjCXrJkP/6Bd+KaVRVV2PI1R1P3AwJGRSXu2TweftbHZE9HBn0GcNXWR8ejheBbi5342U6L2JSUdsHg==","shasum":"d64e1f4ecdb69e2a7aa450df18b79c8eb0048538","tarball":"https://registry.npmjs.org/@aitube/api-client/-/api-client-0.2.4.tgz","fileCount":25,"unpackedSize":44220,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCID8Sd2GBAhcwG72MwwLyIxFd1THQtwupx3fVVtXyil/lAiBfJF9EaakxUycxexraO4ic1PmlPx/LwJXDt1jBk4To0g=="}]},"_npmUser":{"name":"flngr","email":"julian.bilcke@gmail.com"},"directories":{},"maintainers":[{"name":"flngr","email":"julian.bilcke@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/api-client_0.2.4_1725215096380_0.9759145866781751"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-01T18:24:56.273Z","0.2.4":"2024-09-01T18:24:56.579Z","modified":"2024-09-01T18:24:56.860Z"},"maintainers":[{"name":"flngr","email":"julian.bilcke@gmail.com"}],"description":"Official API client for AiTube.at","homepage":"https://github.com/jbilcke-hf/aitube-client#readme","keywords":["Clapper.app","AiTube.at","OpenClap","AI cinema","file format","specification"],"repository":{"type":"git","url":"git+https://github.com/jbilcke-hf/aitube-client.git"},"author":{"name":"Julian Bilcke"},"bugs":{"url":"https://github.com/jbilcke-hf/aitube-client/issues"},"license":"MIT","readme":"# @aitube/api-client\n\n*Official API client for AiTube.at*\n\n## ATTENTION\n\nAiTube is currently in heavy development, and for the moment\nthe API client is reserved for *private use* (it is used by AI Stories Factory).\n\nWe are sorry for any inconvenience this might cause.\n\n## Caveats\n\nThe official domain for AiTube is `aitube.at`, however right now\nthe Hugging Face Space is not configured to use this as a domain,\nso we need to perform all API calls to `jbilcke-hf-ai-tube.hf.space`.\n\n## Installation\n\nTo install the package, run the following command:\n\n```bash\nnpm install @aitube/api-client\n```\n\n## Getting Started\n\nNote: to overridethe AiTube API URL, set this env var: `AITUBE_URL`\n\n```typescript\nimport {\n  createClap,\n  editClapDialogues,\n  editClapEntities,\n  editClapMusic,\n  editClapSounds,\n  editClapStory,\n  editClapStoryboards,\n  editClapVideos,\n  exportClapToVideo,\n  defaultAitubeHostname,\n  defaultClapWidth,\n  defaultClapHeight,\n  defaultExportFormat,\n  aitubeUrl,\n  aitubeApiVersion,\n  aitubeApiUrl,\n  ClapEntityPrompt,\n  SupportedExportFormat,\n  applyClapCompletion,\n } from '@aitube/api-client'\n\nconst ultraSecret = \"ultra secret token unavailable to common mortals\"\n\nconst basicClap = await createClap({\n  prompt: \"story about a dog\",\n  turbo: false,\n  token: ultraSecret\n})\n\nconst illustratedClap = await editClapStoryboards({\n  clap: basicClap,\n  turbo: false,\n  token: ultraSecret\n})\n\nconst mp4VideoFile = await exportClapToVideo({\n  clap: illustratedClap,\n  format: \"mp4\",\n  turbo: false,\n  token: ultraSecret\n})\n```\n\n## Customizing the server\n\nThe hostname can be overriden by defining the `AITUBE_URL` environment variable.\n\neg:\n\n```bash\nAITUBE_URL=http://localhost:3000\n```\n\n## Build Instructions\n\nInstall [Bun](https://bun.sh/)\n\nRun the following commands:\n\n```bash\nbun install\n\nbun run build\n```\n\nTo publish:\n\n```bash\nbun run build\n\nbun run build:declaration\n\nbun run publish\n```\n\n## Contributing\n\nWe welcome contributions! Please feel free to submit a pull request.\n\n## License\n\nThis package is under the MIT License. See `LICENSE` file for more details.\n","readmeFilename":"README.md"}