{ "openapi": "3.1.0", "info": { "title": "transcripts-api", "version": "1.0" }, "servers": [ { "url": "https://api.trint.com/transcripts" } ], "components": { "securitySchemes": { "sec0": { "type": "http", "scheme": "basic" } } }, "security": [ { "sec0": [] } ], "paths": { "/": { "get": { "summary": "List Files", "description": "The list files endpoint returns a list of files (id, title etc) belonging to the current user or accessible via a specified Shared Drive. If a sharedDriveId, the results will list the contents of that drive (or drive Folder if a folderId is also supplied), no matter which user the Trints belong to. Otherwise the results will list the Trints belonging to the user whose API key is supplied. NB: Workspace is simply the old terminology for Shared Drive, calls can be made with a workspaceId instead of a sharedDriveId for backwards compatibility.", "operationId": "page", "parameters": [ { "name": "limit", "in": "query", "description": "Maximum number of transcripts to return. (Minimum value 1, Maximum value 1000)", "schema": { "type": "integer", "format": "int32", "default": 100 } }, { "name": "skip", "in": "query", "description": "Number of transcripts to skip before returning", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "sharedDriveId", "in": "query", "description": "ID of a Trint Shared Drive", "schema": { "type": "string" } }, { "name": "workspaceId (deprecated)", "in": "query", "description": "see sharedDriveId (alternate param name for backwards compatibility)", "schema": { "type": "string" } }, { "name": "folderId", "in": "query", "description": "ID of a Trint Shared Drive Folder (NB: when used, a sharedDriveId/workspaceId must also be given)", "schema": { "type": "string" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "[\n {\n \"id\": \"JbDdNjvGQ8mCKWvDA_tX9Q\",\n \t\"fileType\": \"TRANSCRIPT\",\n \"workspaceId\": null,\n \"folderId\": null,\n \"language\": \"en\",\n \"duration\": 100000,\n \"title\": \"obama.mp4\",\n \"metadata\": \"Arbitrary metadata string\",\n \"excerpt\": \"Our diversity. Our commitment to rule of law. These things give us everything we need to ensure prosperity and security for generations to come. In fact, it's in that spirit. That we have made progress these past seven years.\",\n \"timecodeOffsetEnabled\": true,\n \"timecode\": \"00:00:00.000\", \n \"notes\": \"Notes string\",\n \"updated\": \"2011-10-10T14:48:00.000Z\",\n \"created\": \"2011-10-05T14:48:00.000Z\"\n },\n {\n \"id\": \"kmpgQ1FWQCO_bUXJwDZpnw\",\n \t\"fileType\": \"TRANSCRIPT\",\n \"workspaceId\": null,\n \"folderId\": null,\n \"language\": \"en\",\n \"duration\": 100000,\n \"title\": \"another.mp4\",\n \"metadata\": \"{\\r\\n\\\"keywords\\\": [\\\"example\\\", \\\"json\\\", \\\"metadata\\\"]\\r\\n}\\r\\n\",\n \"excerpt\": \"This is a small test file\",\n \"timecodeOffsetEnabled\": true,\n \"timecode\": \"00:00:00.000\", \n \"notes\": \"Notes string\",\n \"updated\": \"2011-10-10T14:48:00.000Z\",\n \"created\": \"2011-10-05T14:48:00.000Z\"\n },\n {\n \"id\": \"-YD9NFcxScKrL_zNnDyZFw\",\n \t\"fileType\": \"TRANSCRIPT\",\n \"workspaceId\": null,\n \"folderId\": null,\n \"language\": \"en\",\n \"duration\": 100000,\n \"title\": \"/testing/martin-luther-king-cbr.mp3\",\n \"metadata\": \"\",\n \"excerpt\": \"I am happy to join with you today in what will go down in history as the greatest demonstration for freedom in the history of our nation.\",\n \"timecodeOffsetEnabled\": true,\n \"timecode\": \"00:00:00.000\", \n \"notes\": \"Notes string\",\n \"updated\": \"2011-10-10T14:48:00.000Z\",\n \"created\": \"2011-10-05T14:48:00.000Z\"\n }\n]" } }, "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "JbDdNjvGQ8mCKWvDA_tX9Q" }, "fileType": { "type": "string", "example": "TRANSCRIPT" }, "workspaceId": {}, "folderId": {}, "language": { "type": "string", "example": "en" }, "duration": { "type": "integer", "example": 100000, "default": 0 }, "title": { "type": "string", "example": "obama.mp4" }, "metadata": { "type": "string", "example": "Arbitrary metadata string" }, "excerpt": { "type": "string", "example": "Our diversity. Our commitment to rule of law. These things give us everything we need to ensure prosperity and security for generations to come. In fact, it's in that spirit. That we have made progress these past seven years." }, "timecodeOffsetEnabled": { "type": "boolean", "example": true, "default": true }, "timecode": { "type": "string", "example": "00:00:00.000" }, "notes": { "type": "string", "example": "Notes string" }, "updated": { "type": "string", "example": "2011-10-10T14:48:00.000Z" }, "created": { "type": "string", "example": "2011-10-05T14:48:00.000Z" } } } } } } } }, "deprecated": false } }, "/file/{id}": { "get": { "summary": "Retrieve File", "description": "", "operationId": "get-file", "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"id\": \"JbDdNjvGQ8mCKWvDA_tX9Q\",\n \"fileType\": \"TRANSCRIPT\",\n \"workspaceId\": null,\n \"folderId\": null,\n \"language\": \"en\",\n \"duration\": 100000,\n \"title\": \"obama.mp4\",\n \"metadata\": \"Arbitrary metadata string\",\n \"excerpt\": \"Our diversity. Our commitment to rule of law. These things give us everything we need to ensure prosperity and security for generations to come. In fact, it's in that spirit. That we have made progress these past seven years.\",\n \"timecodeOffsetEnabled\": true,\n \"timecode\": \"00:00:00.000\", \n \"notes\": \"Notes string\",\n \"updated\": \"2011-10-10T14:48:00.000Z\",\n \"created\": \"2011-10-05T14:48:00.000Z\"\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "string", "example": "JbDdNjvGQ8mCKWvDA_tX9Q" }, "fileType": { "type": "string", "example": "TRANSCRIPT" }, "workspaceId": {}, "folderId": {}, "language": { "type": "string", "example": "en" }, "duration": { "type": "integer", "example": 100000, "default": 0 }, "title": { "type": "string", "example": "obama.mp4" }, "metadata": { "type": "string", "example": "Arbitrary metadata string" }, "excerpt": { "type": "string", "example": "Our diversity. Our commitment to rule of law. These things give us everything we need to ensure prosperity and security for generations to come. In fact, it's in that spirit. That we have made progress these past seven years." }, "timecodeOffsetEnabled": { "type": "boolean", "example": true, "default": true }, "timecode": { "type": "string", "example": "00:00:00.000" }, "notes": { "type": "string", "example": "Notes string" }, "updated": { "type": "string", "example": "2011-10-10T14:48:00.000Z" }, "created": { "type": "string", "example": "2011-10-05T14:48:00.000Z" } } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": false, "proxy-enabled": false }, "x-readme-fauxas": true }