{"_id":"@atexto/atexto-sdk","_rev":"5-466f962135aa9f2fe5ec49f474067e78","name":"@atexto/atexto-sdk","dist-tags":{"latest":"0.9.1"},"versions":{"0.9.0":{"name":"@atexto/atexto-sdk","version":"0.9.0","description":"","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":"","license":"ISC","dependencies":{"superagent":"^4.0.0","superagent-promise":"^1.1.0"},"gitHead":"b885583fd5cb7e28df89747c9f211b3ac1630014","_id":"@atexto/atexto-sdk@0.9.0","_npmVersion":"6.4.1","_nodeVersion":"8.11.2","_npmUser":{"name":"siedrix","email":"siedrix@gmail.com"},"dist":{"integrity":"sha512-/grgxTz9XTMssX2uxinQcrDa7SAtjR41AFyYfZj0B40shT9zZEv2CRW9Mv4y/3bxQqcnriUQ5Eb6Iugo0PrFJQ==","shasum":"85fe162b99a2ed5c9f6689bdeb337a04f470facc","tarball":"https://registry.npmjs.org/@atexto/atexto-sdk/-/atexto-sdk-0.9.0.tgz","fileCount":3,"unpackedSize":1781,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcBeAKCRA9TVsSAnZWagAAyuQP/jmE43tyI6/U8rVIGv4M\nwmv2ugIG5M1TSG/KNHlt5Ctxra5olJBrqWNhrxk5Sk2sKKlXn4Wj7wrR8wyG\n+5hX6OoPE6y1Xj9bZLIjQMa6deQyf4r1TpCjghJokKUZfeCmEBmzI9TjBt36\nyWiEfock2ooL6k9UQJQbItXy9MwcMRcNR82BPUKvvRRw+ELehUGzWh/Vjh52\ndcOZFOokLR3VtucIUfRYQekoV2XUCRwqPiYbcWpC+5vpBxFd6loP4rH65yX+\nUwAXUwDE9MfG1RnnDdF++TdUb/DAuFph8aNlaj8VH70znjEM7230Lbdo0CE9\nliE4DIQ4f/lGNqV6P2awATjE2UDiDjVhQdehEHrMGld7RuW1sr5fnOXDesBs\nP6QndJzmkq0cDxBpLF5KNcjWeMS/vtLgx2soXuWCNLMxOiHuiVsOiqrQjtye\n9sGiahRY2uZVm9lYHGpwSe88OFnqwuf2uAG2mkJ6evY3LjvHlaPac5ZA2DHb\n+g3rIzrQwy6hyuusT3CJGa6aZnkRW66/6/aVbnOUzbK8MEBMkWfk6nVgcwmI\nQAj8tel1gJdXhmQpJmzk1RCF7TAzPX2thuT2xBhB9TEJ0Hp4rdnK6TEu9R0w\nqrRN6QKF4dAuHEOeK5yCXVfE57oWhL6E9Plvw9UgpZPMNQCUMvqDaD8RWIQ2\nPwLU\r\n=qgdA\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDDUEueb/Lts8hXOqD1Mqd89C7coKR1lSbdtIUDTCmQwwIgIDP8x6KnNM8LN+BCQN5wpi3RR4niMlK8CrKM4ioaMnQ="}]},"maintainers":[{"name":"atextoinc","email":"sensei@atexto.com"},{"name":"siedrix","email":"siedrix@gmail.com"},{"name":"egorupicz","email":"esteban@atexto.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/atexto-sdk_0.9.0_1543888905946_0.583576858720807"},"_hasShrinkwrap":false},"0.9.1":{"name":"@atexto/atexto-sdk","version":"0.9.1","description":"### Install Atexto SDK","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":"","license":"ISC","dependencies":{"qs":"^6.6.0","superagent":"^4.0.0","superagent-promise":"^1.1.0"},"gitHead":"978668f5d900207ceeb443a2f22bb70f88d42c49","_id":"@atexto/atexto-sdk@0.9.1","_npmVersion":"6.4.1","_nodeVersion":"8.11.2","_npmUser":{"name":"siedrix","email":"siedrix@gmail.com"},"dist":{"integrity":"sha512-TDAKBwV87PP99A9VeSV28OWicQUZRAXuLxT6h48W1lAU3i5i34oO+y9xjgElYJdUnjuG+lGFlBwjKYHTNlRRRQ==","shasum":"80db05d5401efcd771fbef39ec76786a57f2b618","tarball":"https://registry.npmjs.org/@atexto/atexto-sdk/-/atexto-sdk-0.9.1.tgz","fileCount":3,"unpackedSize":5150,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcNiITCRA9TVsSAnZWagAAlicP+wdvjXVKfrfgaLCclUfe\nMhfLs0W/MuZLCCL5ZKBlFz+iv2QVMwwVpzrSg6wMgXMWHzoBRh7YRDOmR/xp\n2/PVEiLN/OPbBKE4PLxNgVBlSSCBasLfQtZ2ej3/fz3OXj/lvZaCgEOWVR5r\nvK+u7RnesEN/wYS3w9SfqlvomIL15UAgIZ5tf6h+XyyH7qS9gzo1wgdgm2v8\nhTSU/IR4Hik22xxbqRR47tNjxdc0UThpPQ+5JzDkPvDfwUti/T8ZR3oXsY3j\nazIAuv+2/bpqnZLjKIcFfLUkDNyOFpTvSrD9/PB0UfcrTYmaRLQlX17qTEM8\nFdRibCZeaopxGSBzILLHlrt2aTU8X+i+CPaFItfyMV5Dqxg1pPtRczIMCiEa\nrwIeCXuaAxfyfVYOCr0so0UpkTKjffBRtnbVKmEJfaFaNlyGAuvHHmhNcv2T\naMwhmfPsj4p0fCEWo8nBj7uTQTxNd5HYohQTrAxlCdds0nUPLDtuRATPKpcV\njYz2xtq/9O+W9tQunTsmd3Fvfwh2QKFLxrWv+i2U13Awn3UyKrhH7fnneRJL\ngrNG5OjCX7KM9pXvI5UOQI3vPWWdptvQmKGpiatseUz3XRC7zlW8BiDuSO7B\nbkoVeQ1Rdlnvnrj9BEe1KVpxPOQHNHB9Vm0kkTw1d+Dboo8+RHivEvGVHo8N\nzSPe\r\n=sNip\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD2Ae+z7J7+VuYipTdZJSuvf1UxRlwewovJQoIUJ1jkqgIhAMbrwklpH2F0yvhy8YT/XiJ9X5zGlEQ9lVBM86HFBp7g"}]},"maintainers":[{"name":"atextoinc","email":"sensei@atexto.com"},{"name":"egorupicz","email":"esteban@atexto.com"},{"name":"siedrix","email":"siedrix@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/atexto-sdk_0.9.1_1547051538653_0.8950308730160152"},"_hasShrinkwrap":false}},"time":{"created":"2018-12-04T02:01:45.793Z","0.9.0":"2018-12-04T02:01:46.325Z","modified":"2022-04-04T16:03:32.774Z","0.9.1":"2019-01-09T16:32:18.811Z"},"maintainers":[{"email":"ramonchancayortega@gmail.com","name":"devrchancay"},{"email":"vick@atexto.com","name":"vickvasquezz"},{"email":"sensei@atexto.com","name":"atextoinc"},{"email":"esteban@atexto.com","name":"egorupicz"}],"license":"ISC","readme":"# Atexto nodejs-sdk\n\n### Install Atexto SDK\n\nDo `npm i @atexto/atexto-sdk` on you nodejs aplication folder.\n\n### Create a client\n\nTo generate your token key/secret go to https://devs.atext.io, create an account and then a token.\n\nOn your application add the following code to create a client. This client will allow you to create, list and get the detail for your transcriptions.\n\n```js\nconst sdk = require('@atexto/atexto-sdk')\nconst client = new sdk.Client({\n  key: KEY,\n  secret: SECRET\n})\n```\n\n### Create a transcription\n\nUpload the file to the server, then run the following code to create a transcription job in Atexto.\n\n```js\nconst transcript = await client.createTranscript({\n  \"audioSrcUrl\": \"AUDIO_URL\",\n  \"tags\": [\"demo\", \"completed\"],\n  \"speakerCount\": 2,\n  \"languageCode\": \"en\",\n  \"options\": {\n    \"formatText\": false,\n    \"truncatedWords\": false\n  }\n})\n```\n\nThis will return a `transcript` object with this data:\n\n```json\n{\n    \"uuid\": \"16a54748-da46-4080-b4a1-fa18a6b223cf\",\n    \"status\": \"started\",\n    \"audioSrcUrl\": \"AUDIO_URL\",\n    \"language\": \"en\",\n    \"tags\": [\n        \"demo\",\n        \"completed\"\n    ],\n    \"speakerCount\": 2,\n    \"options\": {\n        \"formatText\": false,\n        \"truncatedWords\": false\n    },\n    \"createdAt\": \"2018-12-08T01:25:49.031Z\"\n}\n```\n\nAll available options and parameters to create a transcription job are [here](https://docs.atext.io/article/155-post-transcripts)  in our API docs.\n\n### Get a transcription details\n\nReview a job status and get the transcription once completed, with the following code and the job UUID:\n\n```js\nconst transcript = await client.getTranscript(UUID)\n```\n\nThis will return a `transcript` object with the following data:\n\n```json\n{\n    \"uuid\": \"16a54748-da46-4080-b4a1-fa18a6b223cf\",\n    \"status\": \"processing\",\n    \"audioSrcUrl\": \"AUDIO_URL\",\n    \"language\": \"en\",\n    \"tags\": [\n        \"demo\",\n        \"completed\"\n    ],\n    \"speakerCount\": 2,\n    \"options\": {\n        \"formatText\": false,\n        \"truncatedWords\": false\n    },\n    \"createdAt\": \"2018-12-08T01:25:49.031Z\"\n}\n```\n\n### List a transcriptions\n\nTo list all jobs generated with your account, use the following code:\n\n```js\nconst transcripts = await client.listTranscripts()\n```\n\nThis will return a `transcripts` array with the following data:\n\n```json\n{\n    \"total\": 2,\n    \"data\": [\n        {\n            \"uuid\": \"UUID\",\n            \"status\": \"processing\",\n            \"audioSrcUrl\": \"AUDIO_URL\",\n            \"language\": \"en\",\n            \"tags\": [\n                \"sample\",\n                \"project-1\"\n            ],\n            \"createdAt\": \"2018-12-04T15:42:32.082Z\"\n        },\n        {\n            \"uuid\": \"UUID\",\n            \"status\": \"ready\",\n            \"audioSrcUrl\": \"AUDIO_URL\",\n            \"language\": \"en\",\n            \"tags\": [\n                \"sample\",\n                \"second\"\n            ],\n            \"createdAt\": \"2018-12-04T15:47:11.576Z\"\n        },\n    ]\n}\n```\n\nFor paginated requests use:\n\n```js\nconst transcripts = await client.listTranscripts({start: 20})\n```\n\nThis will skip the most recent 20 jobs.\n\n### Filter a transcriptions\n\nFilter jobs by status or tags, using the following code:\n\n```js\nconst transcripts = await client.listTranscripts({status: 'ready'})\n```\n\nThis will return a `transcripts` array with transcriptions in ready only.","readmeFilename":"README.md","description":"### Install Atexto SDK"}