{"id":49238019,"url":"https://github.com/deepgram/starter-contracts","last_synced_at":"2026-04-24T17:37:09.114Z","repository":{"id":337014516,"uuid":"1044922580","full_name":"deepgram/starter-contracts","owner":"deepgram","description":"Quickly build Deepgram Starter Apps from API specifications and Interface contracts","archived":false,"fork":false,"pushed_at":"2026-02-27T21:56:12.000Z","size":2101,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-28T02:25:36.983Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deepgram.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-26T11:55:28.000Z","updated_at":"2026-02-27T21:56:16.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/deepgram/starter-contracts","commit_stats":null,"previous_names":["deepgram/starter-contracts"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/deepgram/starter-contracts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepgram%2Fstarter-contracts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepgram%2Fstarter-contracts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepgram%2Fstarter-contracts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepgram%2Fstarter-contracts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deepgram","download_url":"https://codeload.github.com/deepgram/starter-contracts/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepgram%2Fstarter-contracts/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32234726,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T13:21:15.438Z","status":"ssl_error","status_checked_at":"2026-04-24T13:21:15.005Z","response_time":64,"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":"2026-04-24T17:37:08.484Z","updated_at":"2026-04-24T17:37:09.106Z","avatar_url":"https://github.com/deepgram.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Deepgram Starter Contracts\n\nA comprehensive collection of API contract specifications for Deepgram's services, providing standardized OpenAPI and AsyncAPI specifications, JSON schemas and conformance tests to help build standardized Deepgram Starter Apps.\n\n## Why Use This Library?\n\nThis repository serves as the definitive source for:\n- **API Contract Specifications**: OpenAPI and AsyncAPI specs for all Deepgram APIs\n- **Schema Definitions**: JSON schemas for request/response validation\n- **Conformance Testing**: Automated tests to ensure API compliance\n- **Developer Documentation**: Clear guides for each API interface\n\n## Getting Started\n\n### Prerequisites\n\nBefore getting started, ensure you have the following installed:\n\n- pnpm for dependency management.\n- Node Version 18 or higher\n\n```bash\n# Node.js (version 18 or higher recommended)\nnode --version\n\n# pnpm package manager\npnpm --version\n\n# If pnpm is not installed:\nnpm install -g pnpm\n```\n\n### Quick Start\n\n1. Clone the Repo:\n\n```bash\ngit@github.com:deepgram/starter-contracts.git\n\ncd starter-apps/starter-contracts\n```\n\n2. Install dependencies:\n\n```bash\n pnpm i\n ```\n\n## Repository Structure\n\n```\ninterfaces/\n├── transcription/         # Transcription (REST API)\n├── text-to-speech/        # Text-to-Speech (REST API)\n├── text-intelligence/     # Text Intelligence services\n├── live-transcription/    # Live Transcription (WebSocket)\n├── live-text-to-speech/   # Live Text-to-Speech (WebSocket)\n├── voice-agent/           # Voice Agent (WebSocket)\n└── flux/                  # Flux (WebSocket)\n```\n\nEach interface directory contains:\n- `asyncapi.yml` or `openapi.yml` - API specification\n- `schema/` - JSON schema definitions\n- `conformance/` - Conformance tests and documentation\n- `README.md` - Interface-specific documentation\n\n## Testing Starter Apps\n\n### Overview\n\nThis repository includes comprehensive conformance tests for validating that your starter applications correctly implement Deepgram API interfaces. Tests ensure your apps work consistently across the ecosystem.\n\n### Available Test Suites\n\nThese are integration tests that require a running starter application implementing the interface you want to test.\n\nRefer to individual READMEs for detailed setup instructions:\n\n**REST**\n- [Transcription](./interfaces/transcription/README.md)\n- [Text-to-Speech](./interfaces/text-to-speech/README.md)\n- [Text Intelligence](./interfaces/text-intelligence/README.md)\n\n**WebSocket**\n- [Live Transcription](./interfaces/live-transcription/README.md)\n- [Live Text-to-Speech](./interfaces/live-text-to-speech/README.md)\n- [Flux](./interfaces/flux/README.md)\n- [Voice Agent](./interfaces/voice-agent/README.md)\n\n## Test Harness for Starter Apps\n\n### Overview\n\nIn addition to interface-specific conformance tests, this repository provides a comprehensive test harness for validating complete starter applications. The test harness performs automated contract testing to ensure starter apps correctly implement core Deepgram SDK features.\n\n### Supported Platforms\n\n- **Node.js**: Full SDK feature testing\n- **Python**: Full SDK feature testing\n- **Browser**: JavaScript SDK testing\n\n### Quick Start\n\n```bash\n# Set up environment\ncp tests/.env.example tests/.env\n# Edit tests/.env with your DEEPGRAM_API_KEY\n\n# Run tests for a starter app\nnpm run test:harness /path/to/starter-app node\nnpm run test:harness /path/to/starter-app python\nnpm run test:harness /path/to/starter-app browser\n```\n\n### What the Test Harness Validates\n\n- ✅ **Speech-to-Text**: Prerecorded transcription with various models and features\n- ✅ **Text-to-Speech**: Audio synthesis with different voices and formats\n- ✅ **Live Transcription**: WebSocket streaming and control messages\n- ✅ **Error Handling**: Invalid inputs, network failures, and edge cases\n- ✅ **SDK Integration**: Proper use of Deepgram SDK methods and signatures\n\n### Documentation\n\nFor detailed information about the test harness, including:\n- Setup and configuration\n- Running specific test suites\n- Troubleshooting common issues\n- Adding new tests\n- CI/CD integration\n\nSee the [Test Harness README](./tests/README.md).\n\n### Adding New Interface Specifications\n\n1. Create a new directory under `interfaces/`\n2. Follow the established structure:\n3. Add conformance tests\n4. Update this main README\n\n### Modifying Existing Specifications\n\n1. Update the relevant specification files\n2. Update corresponding schemas and examples\n3. Run conformance tests to ensure compatibility\n4. Update documentation as needed\n\n## Getting Help\n\n* Report an [issue or bug](https://github.com/deepgram/starter-contracts/issues)\n\n## License\n\nThis project is licensed under the [LICENSE](./LICENSE) file in the repository root.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepgram%2Fstarter-contracts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepgram%2Fstarter-contracts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepgram%2Fstarter-contracts/lists"}