{"id":18950283,"url":"https://github.com/findmypast-oss/speechmatex","last_synced_at":"2026-03-28T05:30:20.950Z","repository":{"id":57551096,"uuid":"87057681","full_name":"findmypast-oss/speechmatex","owner":"findmypast-oss","description":"Speechmatics API Client written in Elixir","archived":false,"fork":false,"pushed_at":"2017-04-04T15:43:12.000Z","size":45,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-02-01T05:48:03.296Z","etag":null,"topics":["api-client","elixir","speech-recognition","speech-to-text"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/findmypast-oss.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}},"created_at":"2017-04-03T09:25:36.000Z","updated_at":"2019-09-15T08:23:51.000Z","dependencies_parsed_at":"2022-09-26T18:41:17.707Z","dependency_job_id":null,"html_url":"https://github.com/findmypast-oss/speechmatex","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/findmypast-oss%2Fspeechmatex","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/findmypast-oss%2Fspeechmatex/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/findmypast-oss%2Fspeechmatex/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/findmypast-oss%2Fspeechmatex/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/findmypast-oss","download_url":"https://codeload.github.com/findmypast-oss/speechmatex/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239946915,"owners_count":19723018,"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":["api-client","elixir","speech-recognition","speech-to-text"],"created_at":"2024-11-08T13:22:08.037Z","updated_at":"2026-03-28T05:30:20.351Z","avatar_url":"https://github.com/findmypast-oss.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Speechmatex\n\n[![Build Status](https://travis-ci.org/findmypast-oss/speechmatex.svg?branch=master)](https://travis-ci.org/findmypast-oss/speechmatex)\n[![Coverage Status](https://coveralls.io/repos/github/findmypast-oss/speechmatex/badge.svg?branch=master)](https://coveralls.io/github/findmypast-oss/speechmatex?branch=master)\n[![Ebert](https://ebertapp.io/github/findmypast-oss/speechmatex.svg)](https://ebertapp.io/github/findmypast-oss/speechmatex)\n[![Hex.pm](https://img.shields.io/hexpm/v/speechmatex.svg)](https://hex.pm/packages/speechmatex)\n\n**Speechmatics API Client written in Elixir**\n\n[Speechmatics API Documentation](https://app.speechmatics.com/api-details)\n\n## Installation\n\nThe package is available via Hex, it can be installed by adding `speechmatex` to your list of dependencies in `mix.exs`:\n\n```elixir\ndef deps do\n  [{:speechmatex, \"~\u003e 0.1.1\"}]\nend\n```\n\nYou will also need to register with Speechmatics and add your user id and auth token to config like so:\n\n```elixir\nuse Mix.Config\n\nconfig :speechmatex,\n  customer_id: 99012,\n  auth_token: \"J4M9ho4m1IU7wFYim9QQNrVU3aUFK5v3\"\n```\n\n## Example Usage\n\n### Account\n\n#### Get Account Details\n\n```elixir\niex\u003e Speechmatex.Account.details()\n{:ok, %{\"balance\" =\u003e 1920, \"email\" =\u003e \"mr_test@testerson.com\", \"id\" =\u003e 43641}}\n```\n\n### Job\n\n#### Send for transcription\n\nSend an audio file off for transcription.\n\n```elixir\niex\u003e Speechmatex.Job.send_for_transcription(\"/home/developer/Downloads/example.mp3\", \"en-GB\")\n\n{:ok, %{\"balance\" =\u003e 1964, \"check_wait\" =\u003e 30, \"cost\" =\u003e 8, \"id\" =\u003e 2293106}}\n```\n\n#### Get transcription\n\nGet the transcription of a completed job.\n\n```elixir\niex\u003e Speechmatex.Job.get_transcription(2293106)\n\n{:ok,\n %{\"format\" =\u003e \"1.0\",\n   \"job\" =\u003e %{\"created_at\" =\u003e \"Tue Apr  4 13:25:57 2017\", \"duration\" =\u003e 79,\n     \"id\" =\u003e 2293106, \"lang\" =\u003e \"en-GB\", \"name\" =\u003e \"DASD.mp3\",\n     \"user_id\" =\u003e 19057},\n   \"speakers\" =\u003e [%{\"confidence\" =\u003e nil, \"duration\" =\u003e \"22.150000\",\n      \"name\" =\u003e \"F2\", \"time\" =\u003e \"12.250000\"},\n    %{\"confidence\" =\u003e nil, \"duration\" =\u003e \"10.010000\", \"name\" =\u003e \"F3\",\n      \"time\" =\u003e \"34.400000\"},\n    %{\"confidence\" =\u003e nil, \"duration\" =\u003e \"23.820000\", \"name\" =\u003e \"F2\",\n      \"time\" =\u003e \"44.410000\"},\n    %{\"confidence\" =\u003e nil, \"duration\" =\u003e \"9.820000\", \"name\" =\u003e \"F3\",\n      \"time\" =\u003e \"68.230000\"}],\n   \"words\" =\u003e [%{\"confidence\" =\u003e \"0.610\", \"duration\" =\u003e \"0.220000\",\n      \"name\" =\u003e \"It's\", \"time\" =\u003e \"12.250000\"},\n    %{\"confidence\" =\u003e \"0.610\", \"duration\" =\u003e \"0.380000\", \"name\" =\u003e \"exciting\",\n      \"time\" =\u003e \"12.510000\"},\n    %{\"confidence\" =\u003e \"0.800\", \"duration\" =\u003e \"0.330000\", \"name\" =\u003e \".\",\n      \"time\" =\u003e \"13.000000\"},\n    %{\"confidence\" =\u003e \"0.320\", \"duration\" =\u003e \"0.140000\", \"name\" =\u003e \"I'm\",\n      \"time\" =\u003e \"13.450000\"},\n    %{\"confidence\" =\u003e \"0.310\", \"duration\" =\u003e \"0.170000\", \"name\" =\u003e \"a\",\n      \"time\" =\u003e \"13.630000\"},\n    %{\"confidence\" =\u003e \"1.000\", \"duration\" =\u003e \"0.060000\", \"name\" =\u003e \"you\",\n      \"time\" =\u003e \"13.940000\"},\n    %{\"confidence\" =\u003e \"1.000\", \"duration\" =\u003e \"0.170000\", \"name\" =\u003e \"know\",\n      \"time\" =\u003e \"14.390000\"}]}}\n```\n\n## To Do\n\n- [ ] Alignment Route\n- [ ] Handle non 200 responses from API\n\n## License\n\nCopyright © 2017 Findmypast\n\nDistributed under the Apache License 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffindmypast-oss%2Fspeechmatex","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffindmypast-oss%2Fspeechmatex","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffindmypast-oss%2Fspeechmatex/lists"}