Operations
The API includes operations for uploading source files, placing orders, retrieving information about orders and files, and downloading finished documents (transcripts or captions) or source files for an order.
Below is a summary of each operation, along with a link to a page with detailed specifications for it.
| Operation | HTTP Resource/verb | Remarks |
|---|---|---|
| Upload file | POST /inputs |
Clients can either upload the file or send a URL from which the file can be retrieved. Returns a URI for identifying the file when placing a transcription or caption order |
| Place Transcription Order | POST /orders |
Orders will be charged to customer's account balance, or place a sandbox mode order Can optionally include a notification URL to which updates about the order will be sent. Returns a summary of the order, including price, and a URL where order details can be retrieved |
| Place Legal Transcription Order | POST /orders |
Orders will be charged to customer's account balance, or place a sandbox mode order Can optionally include a notification URL to which updates about the order will be sent. Returns a summary of the order, including price, and a URL where order details can be retrieved |
| Place AI Transcription Order | POST /orders |
Orders will be charged to customer's account balance, or place a sandbox mode order Can optionally include a notification URL to which updates about the order will be sent. Returns a summary of the order, including price, and a URL where order details can be retrieved |
| Place Caption Order | POST /orders |
Orders will be charged to customer's account balance, or place a sandbox mode order Can optionally include a notification URL to which updates about the order will be sent. Returns a summary of the order, including price, and a URL where order details can be retrieved |
| Place AI Caption Order | POST /orders |
Orders will be charged to customer's account balance, or place a sandbox mode order Can optionally include a notification URL to which updates about the order will be sent. Returns a summary of the order, including price, and a URL where order details can be retrieved |
| Get order details | GET /orders/{order_num} |
Returns details about the order with given order number. This includes information about the file and any completed transcripts or captions, overall status of the order, and any comments exchanged for the order |
| List orders for user | GET /orders |
Returns a list of summary info for orders placed by the user. The list is returned in a paged manner to support efficient operation |
| Delete order data | DELETE /orders/{order_num} |
Delete the data related to the order |
| Cancel an order | POST /orders/cancel |
Orders can only be cancelled if work has not started on them |
| Get attachment info | GET /attachment/{id} |
Returns metadata about the attachment (original file, transcript or caption) with the given id |
| Get attachment content | GET /attachment/{id}/content |
Returns actual file data for the attachment (original file, transcript or caption) with the given id. Using request headers, you can specify the format in which the attachment should be returned (eg plaintext) |
| Get Legal Transcription attachment content | GET /attachment/{id}/content (Legal Transcription) |
Returns actual file data for the legal transcript attachment with the given id. |
| List workspaces for user | GET /workspaces |
Returns a list of workspaces for a user. |
| List templates (Legal Transcription) | GET /templates |
Returns a list of templates for use with Ready to Certify Legal Transcription orders |