{
    "openapi": "3.0.3",
    "info": {
        "title": "Revideo API",
        "version": "v1",
        "description": "Every Revideo developer API endpoint. Keys: rv_test_ (sample results on the searches endpoints, free) and rv_live_ (real data). Full docs: https://revideo.io/developers"
    },
    "servers": [
        {
            "url": "https://revideo.io/api/developer/v1"
        }
    ],
    "security": [
        {
            "bearerAuth": []
        }
    ],
    "components": {
        "securitySchemes": {
            "bearerAuth": {
                "type": "http",
                "scheme": "bearer"
            }
        }
    },
    "paths": {
        "/me": {
            "get": {
                "summary": "Account, plan and allowance",
                "tags": [
                    "Account"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                }
            }
        },
        "/searches": {
            "get": {
                "summary": "List searches",
                "tags": [
                    "Searches"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "Results per page, 1\u2013100",
                        "schema": {
                            "type": "string"
                        },
                        "example": "20"
                    },
                    {
                        "name": "status",
                        "in": "query",
                        "required": false,
                        "description": "pending, processing, completed or failed",
                        "schema": {
                            "type": "string"
                        },
                        "example": "completed"
                    },
                    {
                        "name": "type",
                        "in": "query",
                        "required": false,
                        "description": "basic or deep",
                        "schema": {
                            "type": "string"
                        },
                        "example": "deep"
                    }
                ]
            },
            "post": {
                "summary": "Start a search",
                "tags": [
                    "Searches"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    },
                    "202": {
                        "description": "Queued \u2014 read it with GET /searches/{id}"
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "video_url": {
                                        "type": "string",
                                        "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
                                    },
                                    "type": {
                                        "type": "string",
                                        "example": "basic"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/searches/{id}": {
            "delete": {
                "summary": "Delete a search",
                "tags": [
                    "Searches"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            },
            "get": {
                "summary": "Get a search and its results",
                "tags": [
                    "Searches"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/searches/{id}/evidence-report": {
            "get": {
                "summary": "Evidence report (PDF)",
                "tags": [
                    "Searches"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/searches/{id}/rerun": {
            "post": {
                "summary": "Run a search again",
                "tags": [
                    "Searches"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "example": "basic"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/searches/{id}/share": {
            "delete": {
                "summary": "Stop sharing a search",
                "tags": [
                    "Searches"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            },
            "post": {
                "summary": "Share a search (public link)",
                "tags": [
                    "Searches"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/uploads": {
            "post": {
                "summary": "Start a chunked upload",
                "tags": [
                    "Large file uploads"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "filename": {
                                        "type": "string",
                                        "example": "my-video.mp4"
                                    },
                                    "size_bytes": {
                                        "type": "integer",
                                        "example": 52428800
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/uploads/{id}": {
            "delete": {
                "summary": "Cancel the upload",
                "tags": [
                    "Large file uploads"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            },
            "get": {
                "summary": "Upload status",
                "tags": [
                    "Large file uploads"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/uploads/{id}/complete": {
            "post": {
                "summary": "Finish the upload",
                "tags": [
                    "Large file uploads"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/uploads/{id}/parts/{n}": {
            "put": {
                "summary": "Send one part",
                "tags": [
                    "Large file uploads"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    },
                    {
                        "name": "n",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/deepfake-checks": {
            "post": {
                "summary": "Deepfake check",
                "tags": [
                    "Instant tools"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "video_url": {
                                        "type": "string",
                                        "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/image-searches": {
            "post": {
                "summary": "Image search",
                "tags": [
                    "Instant tools"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "requestBody": {
                    "content": {
                        "multipart/form-data": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "image": {
                                        "type": "string",
                                        "format": "binary"
                                    },
                                    "platform": {
                                        "type": "string",
                                        "example": "youtube"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/keyword-searches": {
            "post": {
                "summary": "Keyword search",
                "tags": [
                    "Instant tools"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "keyword": {
                                        "type": "string",
                                        "example": "my viral video title"
                                    },
                                    "platform": {
                                        "type": "string",
                                        "example": "all"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/library": {
            "get": {
                "summary": "List library videos",
                "tags": [
                    "Library"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "filter",
                        "in": "query",
                        "required": false,
                        "description": "all, copies, watched, unwatched, clean or unsearched",
                        "schema": {
                            "type": "string"
                        },
                        "example": "all"
                    },
                    {
                        "name": "sort",
                        "in": "query",
                        "required": false,
                        "description": "recent, copies, name or oldest",
                        "schema": {
                            "type": "string"
                        },
                        "example": "recent"
                    },
                    {
                        "name": "q",
                        "in": "query",
                        "required": false,
                        "description": "Search by name",
                        "schema": {
                            "type": "string"
                        },
                        "example": ""
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "1\u2013100",
                        "schema": {
                            "type": "string"
                        },
                        "example": "20"
                    }
                ]
            },
            "post": {
                "summary": "Add videos to the library",
                "tags": [
                    "Library"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "video_url": {
                                        "type": "string",
                                        "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/library/from-search/{id}": {
            "post": {
                "summary": "Save a search\u2019s video to the library",
                "tags": [
                    "Library"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/library/{id}": {
            "delete": {
                "summary": "Delete a library video",
                "tags": [
                    "Library"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            },
            "get": {
                "summary": "Get a library video",
                "tags": [
                    "Library"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/library/{id}/file": {
            "get": {
                "summary": "Download a library video",
                "tags": [
                    "Library"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/library/{id}/search": {
            "post": {
                "summary": "Search a library video",
                "tags": [
                    "Library"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "type": {
                                        "type": "string",
                                        "example": "basic"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/monitors": {
            "get": {
                "summary": "List monitors",
                "tags": [
                    "Monitoring"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "active",
                        "in": "query",
                        "required": false,
                        "description": "1 = only active, 0 = only paused",
                        "schema": {
                            "type": "string"
                        },
                        "example": "1"
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "1\u2013100",
                        "schema": {
                            "type": "string"
                        },
                        "example": "20"
                    }
                ]
            },
            "post": {
                "summary": "Watch a video",
                "tags": [
                    "Monitoring"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "video_url": {
                                        "type": "string",
                                        "example": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
                                    },
                                    "frequency": {
                                        "type": "string",
                                        "example": "2day"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/monitors/{id}": {
            "delete": {
                "summary": "Stop watching",
                "tags": [
                    "Monitoring"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            },
            "get": {
                "summary": "Get a monitor",
                "tags": [
                    "Monitoring"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            },
            "patch": {
                "summary": "Change or pause a monitor",
                "tags": [
                    "Monitoring"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "frequency": {
                                        "type": "string",
                                        "example": "weekly"
                                    },
                                    "active": {
                                        "type": "boolean",
                                        "example": true
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/monitors/{id}/check": {
            "post": {
                "summary": "Check a monitor now",
                "tags": [
                    "Monitoring"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/dmca/notices": {
            "get": {
                "summary": "List DMCA notices",
                "tags": [
                    "DMCA notices"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "filter",
                        "in": "query",
                        "required": false,
                        "description": "all, sent, removed, problem or draft",
                        "schema": {
                            "type": "string"
                        },
                        "example": "all"
                    },
                    {
                        "name": "per_page",
                        "in": "query",
                        "required": false,
                        "description": "1\u2013100",
                        "schema": {
                            "type": "string"
                        },
                        "example": "20"
                    }
                ]
            },
            "post": {
                "summary": "Draft DMCA notices from a search",
                "tags": [
                    "DMCA notices"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "search_id": {
                                        "type": "string",
                                        "example": "{{search_id}}"
                                    },
                                    "all": {
                                        "type": "boolean",
                                        "example": true
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/dmca/notices/{id}": {
            "get": {
                "summary": "Get a notice",
                "tags": [
                    "DMCA notices"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/dmca/notices/{id}/check-link": {
            "post": {
                "summary": "Check if the copy is still up",
                "tags": [
                    "DMCA notices"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/dmca/notices/{id}/decision": {
            "post": {
                "summary": "Decide after a counter-notice",
                "tags": [
                    "DMCA notices"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "decision": {
                                        "type": "string",
                                        "example": "evidence"
                                    },
                                    "confirm": {
                                        "type": "boolean",
                                        "example": true
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/dmca/notices/{id}/notes": {
            "patch": {
                "summary": "Save notes on a notice",
                "tags": [
                    "DMCA notices"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "notes": {
                                        "type": "string",
                                        "example": "Followed up by email."
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/dmca/notices/{id}/response": {
            "post": {
                "summary": "Record the platform\u2019s response",
                "tags": [
                    "DMCA notices"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "outcome": {
                                        "type": "string",
                                        "example": "removed"
                                    },
                                    "note": {
                                        "type": "string",
                                        "example": ""
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/dmca/notices/{id}/sent": {
            "post": {
                "summary": "Record a notice as sent",
                "tags": [
                    "DMCA notices"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ],
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "via": {
                                        "type": "string",
                                        "example": "portal"
                                    },
                                    "reference": {
                                        "type": "string",
                                        "example": "case-123"
                                    },
                                    "affirm": {
                                        "type": "boolean",
                                        "example": true
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/dmca/notices/{id}/withdraw": {
            "post": {
                "summary": "Withdraw a notice",
                "tags": [
                    "DMCA notices"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/authorised-accounts": {
            "get": {
                "summary": "List authorised accounts",
                "tags": [
                    "Settings"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                }
            },
            "post": {
                "summary": "Authorise an account",
                "tags": [
                    "Settings"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "handle": {
                                        "type": "string",
                                        "example": "@yourhandle"
                                    },
                                    "reason": {
                                        "type": "string",
                                        "example": "Our partner channel"
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "/authorised-accounts/{id}": {
            "delete": {
                "summary": "Remove an authorised account",
                "tags": [
                    "Settings"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "parameters": [
                    {
                        "name": "id",
                        "in": "path",
                        "required": true,
                        "schema": {
                            "type": "string"
                        }
                    }
                ]
            }
        },
        "/takedown-details": {
            "get": {
                "summary": "Get takedown details",
                "tags": [
                    "Settings"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                }
            },
            "patch": {
                "summary": "Save takedown details",
                "tags": [
                    "Settings"
                ],
                "responses": {
                    "200": {
                        "description": "OK \u2014 {\"success\": true, \"data\": \u2026}"
                    },
                    "401": {
                        "description": "Missing or invalid key"
                    },
                    "403": {
                        "description": "Plan does not include the API, or a test key on a live-only endpoint"
                    },
                    "422": {
                        "description": "A field is missing or wrong"
                    },
                    "429": {
                        "description": "Rate limit or plan allowance reached"
                    }
                },
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "object",
                                "properties": {
                                    "from": {
                                        "type": "string",
                                        "example": "Your Name"
                                    },
                                    "email": {
                                        "type": "string",
                                        "example": "legal@yourcompany.com"
                                    },
                                    "company": {
                                        "type": "string",
                                        "example": "Your Company Ltd."
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}