Operations
GET /attachments/{id}
Summary | Get metadata about an order attachment |
---|---|
URL | /api/v1/attachments/{id} |
Detailed Description | Use this method to retrieve information (metadata) about an order attachment.
Attachments are either source files (audio or video for transcription orders, videos for caption orders)
or output files (transcripts or captions, depending on the type of order).
The data will be returned as JSON or XML, depending on Accept header or URL extension. See below for an annotated example of a response entity. To retrieve the actual file contents, use the GET /attachments/{id}/content operation. |
Request Parameters |
|
Request Headers |
|
Response | On success, 200 OK. If the attachment with given id is not found, 404 Not Found |
Response Headers |
|
Deliverable Type | For attachments that are deliverables, the following list represents possible types of deliverable values: transcript - Human transcripts for transcription orders
instant_first_draft - Instant first draft AI transcripts for transcription orders
ai_transcript - AI transcripts for AI transcription orders
legal_ready_to_certify - Legal Ready to Certify transcripts for legal transcription orders
legal_human_rough_draft - Legal Human Rough Draft transcripts for legal transcription orders
legal_ai_rough_draft - Legal AI Rough Draft transcripts for legal transcription orders
caption - Human captions for caption orders
burned_in_caption - Burned in captions for caption orders
subtitle - Foreign language subtitles for caption orders
ai_caption - AI captions for AI caption orders
|
Response Body | On success, an <attachment/> entity with the details about the attachment. On error, empty. |
Error Codes | None |
Annotated sample response |
{ /* Attachment type. Possible values are: media, transcript, caption. */ "kind": "media", /* Filename for the attachment */ "name": "VoiceRecording.mp3", /* Id for the attachment */ "id": "1C4AA80F4000000001000000F2EED32A3DD4775B1B0", "links": [ { /* Link with URL of the resource for getting attachment content */ "rel": "content", "href": "https://api.rev.com/api/v1/attachments/1C4AA8" } ] } <attachment> <!— Attachment type. Possible values are: media, transcript, caption. --> <kind>media</kind> <!-- Filename for the attachment --> <name>VoiceRecording.mp3</name> <!— Id for the attachment → <id>1C4AA80F4000000001000000F2EED32A3DD4775B1B0</id> <!— Link with URL of the resource for getting attachment content --> <link rel="content" href="https://api.rev.com/api/v1/attachments/1C4AA8" /> </attachment> |