{ "opencollection": "1.0.0", "info": { "name": "Mux Animated Images Annotations API", "version": "v1" }, "items": [ { "info": { "name": "Annotations", "type": "folder" }, "items": [ { "info": { "name": "List Annotations", "type": "http" }, "http": { "method": "GET", "url": "https://api.mux.com/data/v1/annotations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Number of items to include in the response" }, { "name": "page", "value": "", "type": "query", "description": "Offset by this many pages, of the size of `limit`" }, { "name": "order_direction", "value": "", "type": "query", "description": "Sort order." }, { "name": "timeframe[]", "value": "", "type": "query", "description": "Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).\n\nAccepted formats are...\n\n * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`\n * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`\n" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns a list of annotations." }, { "info": { "name": "Create Annotation", "type": "http" }, "http": { "method": "POST", "url": "https://api.mux.com/data/v1/annotations", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Creates a new annotation." }, { "info": { "name": "Get Annotation", "type": "http" }, "http": { "method": "GET", "url": "https://api.mux.com/data/v1/annotations/:ANNOTATION_ID", "params": [ { "name": "ANNOTATION_ID", "value": "", "type": "path", "description": "The annotation ID" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Returns the details of a specific annotation." }, { "info": { "name": "Update Annotation", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.mux.com/data/v1/annotations/:ANNOTATION_ID", "params": [ { "name": "ANNOTATION_ID", "value": "", "type": "path", "description": "The annotation ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Updates an existing annotation." }, { "info": { "name": "Delete Annotation", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.mux.com/data/v1/annotations/:ANNOTATION_ID", "params": [ { "name": "ANNOTATION_ID", "value": "", "type": "path", "description": "The annotation ID" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes an annotation." } ] } ], "bundled": true }