Method: GET
url: /api/v1/metadata/file-id
eg: https://scribie.com/api/v1/metadata/cc8caa3b2fa5b5f639da1283d778040bfd1fe9b8
Description: GET on a given URL will fetch the metadata of the file represented by the file-id in the body of the response.
Metadata of a file consist of:
| Attribute | Description | Values |
|---|---|---|
| name | Name of the file | |
| created | date and time when file was created | eg “2013-07-31T16:23:26” |
| duration | duration of the file in format hh:min:sec | eg “00:02:54” |
| bytes | size of file in bytes | eg 1041984 |
| size | size of the file in Kb | eg “1017.57 KB” |
| status | status of file | PENDING|PAID |
| amount | amount in USD | eg 4.35 |
| currency | Currency for payment | only “USD” is supported |
| options | options before ordering a transcript | Detailed description in below table |
| transaction_id | Transaction Id of the file if ordered | eg “fsskm2”. Null if not ordered |
| ordered | Date and time when order was placed. | eg “2013-07-31T16:23:26” |
| refund_amount | Amount to be refunded if the order is cancelledor discount is availed | |
| discount | discount if availed |
Options consist of the following:
| Attribute | Description | Values | Default Values |
|---|---|---|---|
| turn_around_time | Number of days for delivery | 12_hour 1_day 7_day 30_day |
1_day |
| additional_proofreading | The transcript will be proofread twice instead of once if enabled | 0 (disabled) 1 (enabled) |
0 (disabled) |
| time_coding | timestamp will be added in transcripts if enabled | 0 (disabled) 1 (enabled) |
1 (enabled) |
| speaker_tracking | Speakers will be tracked as part of the transcript | 0 (disabled) 1 (enabled) |
1 (enabled) |
| speaker_tracking_format | To indicate if for tracking speakers you need fullname or just the initials | initials fullname |
initials |
| speaker_names | names of the speaker to be used for speaker tracking. | The names should have first name followed by last name. It should not have any special characters. If there is no second name then the whole name is ignored. | |
| transcript_template | different templates are supported to represent the final transcript | scribie_single_line_spaced scribie_double_line_spaced blank_single_line_spaced blank_double_line_spaced |
scribie_single_line_spaced |
| strict_verbatim | Include all utterances (e.g. Mm-hmm, uh-huh, umm, uh, etc.) if enabled | 0 (disabled) 1 (enabled) |
0 (disabled) |
| spelling_style | The spelling style specifies the dictionary used for spell checks | American British Australian Canadian |
1 (enabled) |
| subtitle | A subtitle file will also be provided. It will be formatted as SBV and can be used as YouTube caption file and with other video players | 0 (disabled) 1 (enabled) |
0 (disabled) |
Example (curl)
Request:
curl -k -u a7f31ed17c91c1e541c6213ec73128ed15bccee9: https://scribie.com/api/v1/metadata/cc8caa3b2fa5b5f639da1283d778040bfd1fe9b8
Response:
"name": "AachenCathedral",
"created": "2013-08-01T16:09:18",
"seconds": 174,
"duration": "00:02:54",
"bytes": 1041984,
"size": "1017.57 KB",
"status": "pending",
"amount": 4.35,
"currency": "USD",
"options": {
"additional_proofreading": 0,
"time_coding": 1,
"speaker_tracking": 1,
"speaker_tracking_format": "initials",
"speaker_names": "",
"strict_verbatim": 0,
"transcript_template": "scribie_single_line_spaced",
"subtitle": 0,
"spelling_style": "British",
"turn_around_time": "7_day"
},
"transaction_id": null,
"ordered": "2013-08-01T16:09:18",
"refund_amount": 0,
"discount": 0
Method: POST
url: /api/v1/metadata/file-id
eg: https://scribie.com/api/v1/metadata/cc8caa3b2fa5b5f639da1283d778040bfd1fe9b8
Description: POST on a given URL will update the metadata.
The attributes that can be changed are:
- the order options
- name of the file
The data to be changed is passed as part of the request body. The content type should be set to json.
Request:
For options:
curl -k -u a7f31ed17c91c1e541c6213ec73128ed15bccee9: -H "Content-Type: application/json"
-X POST -d '{"options":{"additional_proofreading":0,"subtitle":0}}'
https://scribie.com/api/v1/metadata/5a5290c74787b392e31bfc81124ec11c9abf622c
For filename:
curl -k -u a7f31ed17c91c1e541c6213ec73128ed15bccee9: -H "Content-Type: application/json"
-X POST -d '{"name":"abc"}' https://scribie.yukti/api/v1/metadata/5a5290c74787b392e31bfc81124ec11c9abf622c
Response:
""%