{
  "openapi": "3.1.0",
  "info": {
    "title": "MultiSession Local API",
    "version": "1.0.0",
    "description": "Control MultiSession profiles from scripts on the same computer. Served by the desktop app on 127.0.0.1."
  },
  "servers": [
    {
      "url": "http://127.0.0.1:45100"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "paths": {
    "/v1/status": {
      "get": {
        "operationId": "status",
        "summary": "The app's version, who is signed in, the browser engine and the rate limit. Not counted against the limit.",
        "description": "The app's version, who is signed in, the browser engine and the rate limit. Not counted against the limit.\n\nErrors this endpoint can answer: UNAUTHORIZED, FORBIDDEN_HOST, FORBIDDEN_ORIGIN.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "app",
                    "version",
                    "api",
                    "signedIn",
                    "account",
                    "engine",
                    "limits"
                  ],
                  "properties": {
                    "app": {
                      "type": "string",
                      "enum": [
                        "MultiSession"
                      ]
                    },
                    "version": {
                      "type": "string",
                      "description": "The desktop app's version"
                    },
                    "api": {
                      "type": "string",
                      "enum": [
                        "v1"
                      ]
                    },
                    "signedIn": {
                      "type": "boolean",
                      "description": "false while the app window is closed, loading or signed out"
                    },
                    "account": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "required": [
                        "email"
                      ],
                      "properties": {
                        "email": {
                          "type": "string",
                          "format": "email"
                        }
                      }
                    },
                    "engine": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "required": [
                        "name",
                        "version"
                      ],
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "version": {
                          "type": "string"
                        }
                      }
                    },
                    "limits": {
                      "type": "object",
                      "required": [
                        "requestsPerMinute"
                      ],
                      "properties": {
                        "requestsPerMinute": {
                          "type": "integer"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/openapi.json": {
      "get": {
        "operationId": "openapi",
        "summary": "This API described as an OpenAPI 3.1 document, ready to import into Postman. Not counted against the rate limit.",
        "description": "This API described as an OpenAPI 3.1 document, ready to import into Postman. Not counted against the rate limit.\n\nErrors this endpoint can answer: UNAUTHORIZED, FORBIDDEN_HOST, FORBIDDEN_ORIGIN.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "openapi",
                    "info",
                    "paths"
                  ],
                  "properties": {
                    "openapi": {
                      "type": "string"
                    },
                    "info": {
                      "type": "object"
                    },
                    "paths": {
                      "type": "object"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/{id}/start": {
      "post": {
        "operationId": "profiles.start",
        "summary": "Starts the profile and returns where to attach Playwright, Puppeteer or Selenium.",
        "description": "Starts the profile and returns where to attach Playwright, Puppeteer or Selenium.\n\nErrors this endpoint can answer: INVALID_PROFILE_ID, INVALID_BODY, INVALID_START_URL, INVALID_LOCAL_PASSWORD, INVALID_SELENIUM, INVALID_HEADLESS, PROFILE_NOT_FOUND, PROFILE_LOCKED, PROFILE_BUSY, ALREADY_RUNNING, RUNNING_WITHOUT_AUTOMATION, LOCAL_PASSWORD_REQUIRED, LOCAL_PASSWORD_INVALID, LAUNCH_BLOCKED, LAUNCH_FAILED, SESSION_FAILED, CHROMEDRIVER_UNAVAILABLE, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "startUrl": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "pattern": "^https?://",
                    "description": "An http or https URL to open instead of the profile's own start page"
                  },
                  "localPassword": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "maxLength": 256,
                    "description": "The profile's local password, if it has one"
                  },
                  "selenium": {
                    "type": "boolean",
                    "description": "true adds a matching chromedriver to the answer"
                  },
                  "headless": {
                    "type": "boolean",
                    "description": "true starts without a window and false with one, for this start only. Absent follows the profile's own setting"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "profileId",
                    "sessionId",
                    "cdp"
                  ],
                  "properties": {
                    "profileId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "sessionId": {
                      "type": "string"
                    },
                    "cdp": {
                      "type": "object",
                      "required": [
                        "port",
                        "http",
                        "ws",
                        "debuggerAddress"
                      ],
                      "properties": {
                        "port": {
                          "type": "integer"
                        },
                        "http": {
                          "type": "string",
                          "description": "For Playwright connectOverCDP and Puppeteer browserURL"
                        },
                        "ws": {
                          "type": "string",
                          "description": "The DevTools WebSocket"
                        },
                        "debuggerAddress": {
                          "type": "string",
                          "description": "For Selenium ChromeOptions debugger_address"
                        }
                      }
                    },
                    "chromedriver": {
                      "type": "object",
                      "required": [
                        "path",
                        "version"
                      ],
                      "properties": {
                        "path": {
                          "type": "string"
                        },
                        "version": {
                          "type": "string"
                        }
                      }
                    },
                    "warnings": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/{id}/stop": {
      "post": {
        "operationId": "profiles.stop",
        "summary": "Closes the browser, uploads the profile's data and releases its lock.",
        "description": "Closes the browser, uploads the profile's data and releases its lock.\n\nErrors this endpoint can answer: INVALID_PROFILE_ID, NOT_RUNNING, PROFILE_BUSY, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "profileId"
                  ],
                  "properties": {
                    "profileId": {
                      "type": "string",
                      "format": "uuid"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/start": {
      "post": {
        "operationId": "run.startMany",
        "summary": "Starts up to 20 profiles, three at a time, each as the single start does. Answers 200 with a result per profile; a refused profile carries the single start's error code while the others start.",
        "description": "Starts up to 20 profiles, three at a time, each as the single start does. Answers 200 with a result per profile; a refused profile carries the single start's error code while the others start.\n\nErrors this endpoint can answer: INVALID_BODY, INVALID_IDS, INVALID_SELENIUM, INVALID_HEADLESS, CHROMEDRIVER_UNAVAILABLE, APP_NOT_READY.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "ids"
                ],
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "minItems": 1,
                    "maxItems": 20,
                    "description": "Profile ids, each once"
                  },
                  "selenium": {
                    "type": "boolean",
                    "description": "true adds a matching chromedriver to the answer"
                  },
                  "headless": {
                    "type": "boolean",
                    "description": "true starts without a window and false with one, for this start only. Absent follows the profile's own setting"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "results"
                  ],
                  "properties": {
                    "results": {
                      "type": "array",
                      "description": "One result per id, in the order the ids were sent",
                      "items": {
                        "oneOf": [
                          {
                            "type": "object",
                            "required": [
                              "profileId",
                              "ok",
                              "data"
                            ],
                            "properties": {
                              "profileId": {
                                "type": "string",
                                "format": "uuid"
                              },
                              "ok": {
                                "type": "boolean",
                                "enum": [
                                  true
                                ]
                              },
                              "data": {
                                "type": "object",
                                "required": [
                                  "profileId",
                                  "sessionId",
                                  "cdp"
                                ],
                                "properties": {
                                  "profileId": {
                                    "type": "string",
                                    "format": "uuid"
                                  },
                                  "sessionId": {
                                    "type": "string"
                                  },
                                  "cdp": {
                                    "type": "object",
                                    "required": [
                                      "port",
                                      "http",
                                      "ws",
                                      "debuggerAddress"
                                    ],
                                    "properties": {
                                      "port": {
                                        "type": "integer"
                                      },
                                      "http": {
                                        "type": "string",
                                        "description": "For Playwright connectOverCDP and Puppeteer browserURL"
                                      },
                                      "ws": {
                                        "type": "string",
                                        "description": "The DevTools WebSocket"
                                      },
                                      "debuggerAddress": {
                                        "type": "string",
                                        "description": "For Selenium ChromeOptions debugger_address"
                                      }
                                    }
                                  },
                                  "chromedriver": {
                                    "type": "object",
                                    "required": [
                                      "path",
                                      "version"
                                    ],
                                    "properties": {
                                      "path": {
                                        "type": "string"
                                      },
                                      "version": {
                                        "type": "string"
                                      }
                                    }
                                  },
                                  "warnings": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    }
                                  }
                                }
                              }
                            }
                          },
                          {
                            "type": "object",
                            "required": [
                              "profileId",
                              "ok",
                              "error"
                            ],
                            "properties": {
                              "profileId": {
                                "type": "string",
                                "format": "uuid"
                              },
                              "ok": {
                                "type": "boolean",
                                "enum": [
                                  false
                                ]
                              },
                              "error": {
                                "type": "object",
                                "required": [
                                  "code",
                                  "message"
                                ],
                                "properties": {
                                  "code": {
                                    "type": "string"
                                  },
                                  "message": {
                                    "type": "string"
                                  },
                                  "details": {
                                    "type": "object"
                                  }
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/stop": {
      "post": {
        "operationId": "run.stopMany",
        "summary": "Stops up to 20 profiles, three at a time, each as the single stop does. Answers 200 with a result per profile; a refused profile carries the single stop's error code.",
        "description": "Stops up to 20 profiles, three at a time, each as the single stop does. Answers 200 with a result per profile; a refused profile carries the single stop's error code.\n\nErrors this endpoint can answer: INVALID_BODY, INVALID_IDS, APP_NOT_READY.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "ids"
                ],
                "properties": {
                  "ids": {
                    "type": "array",
                    "items": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "minItems": 1,
                    "maxItems": 20,
                    "description": "Profile ids, each once"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "results"
                  ],
                  "properties": {
                    "results": {
                      "type": "array",
                      "description": "One result per id, in the order the ids were sent",
                      "items": {
                        "oneOf": [
                          {
                            "type": "object",
                            "required": [
                              "profileId",
                              "ok",
                              "data"
                            ],
                            "properties": {
                              "profileId": {
                                "type": "string",
                                "format": "uuid"
                              },
                              "ok": {
                                "type": "boolean",
                                "enum": [
                                  true
                                ]
                              },
                              "data": {
                                "type": "object",
                                "required": [
                                  "profileId"
                                ],
                                "properties": {
                                  "profileId": {
                                    "type": "string",
                                    "format": "uuid"
                                  }
                                }
                              }
                            }
                          },
                          {
                            "type": "object",
                            "required": [
                              "profileId",
                              "ok",
                              "error"
                            ],
                            "properties": {
                              "profileId": {
                                "type": "string",
                                "format": "uuid"
                              },
                              "ok": {
                                "type": "boolean",
                                "enum": [
                                  false
                                ]
                              },
                              "error": {
                                "type": "object",
                                "required": [
                                  "code",
                                  "message"
                                ],
                                "properties": {
                                  "code": {
                                    "type": "string"
                                  },
                                  "message": {
                                    "type": "string"
                                  },
                                  "details": {
                                    "type": "object"
                                  }
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/stop-all": {
      "post": {
        "operationId": "run.stopAll",
        "summary": "Stops every profile the API started on this computer, and none opened by hand. Answers a result per profile it stopped.",
        "description": "Stops every profile the API started on this computer, and none opened by hand. Answers a result per profile it stopped.\n\nErrors this endpoint can answer: APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "results"
                  ],
                  "properties": {
                    "results": {
                      "type": "array",
                      "description": "One result per id, in the order the ids were sent",
                      "items": {
                        "oneOf": [
                          {
                            "type": "object",
                            "required": [
                              "profileId",
                              "ok",
                              "data"
                            ],
                            "properties": {
                              "profileId": {
                                "type": "string",
                                "format": "uuid"
                              },
                              "ok": {
                                "type": "boolean",
                                "enum": [
                                  true
                                ]
                              },
                              "data": {
                                "type": "object",
                                "required": [
                                  "profileId"
                                ],
                                "properties": {
                                  "profileId": {
                                    "type": "string",
                                    "format": "uuid"
                                  }
                                }
                              }
                            }
                          },
                          {
                            "type": "object",
                            "required": [
                              "profileId",
                              "ok",
                              "error"
                            ],
                            "properties": {
                              "profileId": {
                                "type": "string",
                                "format": "uuid"
                              },
                              "ok": {
                                "type": "boolean",
                                "enum": [
                                  false
                                ]
                              },
                              "error": {
                                "type": "object",
                                "required": [
                                  "code",
                                  "message"
                                ],
                                "properties": {
                                  "code": {
                                    "type": "string"
                                  },
                                  "message": {
                                    "type": "string"
                                  },
                                  "details": {
                                    "type": "object"
                                  }
                                }
                              }
                            }
                          }
                        ]
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/running": {
      "get": {
        "operationId": "run.running",
        "summary": "What runs on this computer, opened by hand or through the API, with where to attach to the profiles the API started.",
        "description": "What runs on this computer, opened by hand or through the API, with where to attach to the profiles the API started.\n\nErrors this endpoint can answer: INVALID_PAGE, INVALID_PAGE_SIZE, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "description": "Default 1"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Default 50"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "items",
                    "page",
                    "pageSize",
                    "total"
                  ],
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "profileId",
                          "sessionId",
                          "state",
                          "startedByApi",
                          "cdp"
                        ],
                        "properties": {
                          "profileId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "sessionId": {
                            "type": "string"
                          },
                          "state": {
                            "type": "string",
                            "enum": [
                              "starting",
                              "running",
                              "stopping",
                              "syncing"
                            ]
                          },
                          "startedByApi": {
                            "type": "boolean",
                            "description": "false for a profile opened by hand in the app"
                          },
                          "cdp": {
                            "oneOf": [
                              {
                                "type": "object",
                                "required": [
                                  "port",
                                  "http",
                                  "ws",
                                  "debuggerAddress"
                                ],
                                "properties": {
                                  "port": {
                                    "type": "integer"
                                  },
                                  "http": {
                                    "type": "string",
                                    "description": "For Playwright connectOverCDP and Puppeteer browserURL"
                                  },
                                  "ws": {
                                    "type": "string",
                                    "description": "The DevTools WebSocket"
                                  },
                                  "debuggerAddress": {
                                    "type": "string",
                                    "description": "For Selenium ChromeOptions debugger_address"
                                  }
                                }
                              },
                              {
                                "type": "null"
                              }
                            ],
                            "description": "null for a profile opened by hand, or one still starting"
                          }
                        }
                      }
                    },
                    "page": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "pageSize": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 100
                    },
                    "total": {
                      "type": "integer",
                      "minimum": 0
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/proxies": {
      "get": {
        "operationId": "proxies.list",
        "summary": "The proxies of one workspace, a page at a time. Pass the workspace as the workspaceId query parameter.",
        "description": "The proxies of one workspace, a page at a time. Pass the workspace as the workspaceId query parameter.\n\nErrors this endpoint can answer: INVALID_QUERY, INVALID_PAGE, INVALID_PAGE_SIZE, APP_NOT_READY, APP_TIMEOUT, APP_ERROR, FORBIDDEN, NOT_FOUND.",
        "parameters": [
          {
            "name": "workspaceId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "The workspace the proxy belongs to"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "description": "Default 1"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Default 50"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "items",
                    "page",
                    "pageSize",
                    "total"
                  ],
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "workspaceId",
                          "name",
                          "type",
                          "host",
                          "port",
                          "username",
                          "hasPassword",
                          "country",
                          "lastCheck"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "workspaceId": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "HTTP",
                              "HTTPS",
                              "SOCKS5"
                            ]
                          },
                          "host": {
                            "type": "string"
                          },
                          "port": {
                            "type": "integer",
                            "minimum": 1,
                            "maximum": 65535
                          },
                          "username": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "hasPassword": {
                            "type": "boolean",
                            "description": "The password itself is never returned"
                          },
                          "country": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "description": "Two-letter country code of the proxy's exit address, once it has been checked"
                          },
                          "lastCheck": {
                            "type": [
                              "object",
                              "null"
                            ],
                            "required": [
                              "ok",
                              "at"
                            ],
                            "properties": {
                              "ok": {
                                "type": "boolean"
                              },
                              "at": {
                                "type": "string",
                                "format": "date-time"
                              }
                            }
                          }
                        }
                      }
                    },
                    "page": {
                      "type": "integer"
                    },
                    "pageSize": {
                      "type": "integer"
                    },
                    "total": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "proxies.create",
        "summary": "Adds a proxy to a workspace. The password is stored but never returned.",
        "description": "Adds a proxy to a workspace. The password is stored but never returned.\n\nErrors this endpoint can answer: INVALID_BODY, PLAN_LIMIT, INVALID_REQUEST, CONFLICT, APP_NOT_READY, APP_TIMEOUT, APP_ERROR, FORBIDDEN, NOT_FOUND.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "workspaceId",
                  "type",
                  "host",
                  "port"
                ],
                "additionalProperties": false,
                "properties": {
                  "workspaceId": {
                    "type": "string",
                    "format": "uuid"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "HTTP",
                      "HTTPS",
                      "SOCKS5"
                    ]
                  },
                  "host": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255
                  },
                  "port": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 65535
                  },
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255,
                    "description": "Defaults to host:port"
                  },
                  "username": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "password": {
                    "type": "string",
                    "maxLength": 255
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "workspaceId",
                    "name",
                    "type",
                    "host",
                    "port",
                    "username",
                    "hasPassword",
                    "country",
                    "lastCheck"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "workspaceId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "HTTP",
                        "HTTPS",
                        "SOCKS5"
                      ]
                    },
                    "host": {
                      "type": "string"
                    },
                    "port": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    },
                    "username": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "hasPassword": {
                      "type": "boolean",
                      "description": "The password itself is never returned"
                    },
                    "country": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Two-letter country code of the proxy's exit address, once it has been checked"
                    },
                    "lastCheck": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "required": [
                        "ok",
                        "at"
                      ],
                      "properties": {
                        "ok": {
                          "type": "boolean"
                        },
                        "at": {
                          "type": "string",
                          "format": "date-time"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/proxies/{id}": {
      "patch": {
        "operationId": "proxies.update",
        "summary": "Changes any of a proxy's fields; send at least one. Pass the workspace as the workspaceId query parameter.",
        "description": "Changes any of a proxy's fields; send at least one. Pass the workspace as the workspaceId query parameter.\n\nErrors this endpoint can answer: INVALID_PROXY_ID, INVALID_QUERY, INVALID_BODY, PROXY_NOT_FOUND, INVALID_REQUEST, CONFLICT, APP_NOT_READY, APP_TIMEOUT, APP_ERROR, FORBIDDEN, NOT_FOUND.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "The workspace the proxy belongs to"
            }
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "type": {
                    "type": "string",
                    "enum": [
                      "HTTP",
                      "HTTPS",
                      "SOCKS5"
                    ]
                  },
                  "host": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255
                  },
                  "port": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 65535
                  },
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 255
                  },
                  "username": {
                    "type": "string",
                    "maxLength": 255
                  },
                  "password": {
                    "type": "string",
                    "maxLength": 255
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "workspaceId",
                    "name",
                    "type",
                    "host",
                    "port",
                    "username",
                    "hasPassword",
                    "country",
                    "lastCheck"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "workspaceId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "HTTP",
                        "HTTPS",
                        "SOCKS5"
                      ]
                    },
                    "host": {
                      "type": "string"
                    },
                    "port": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 65535
                    },
                    "username": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "hasPassword": {
                      "type": "boolean",
                      "description": "The password itself is never returned"
                    },
                    "country": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "Two-letter country code of the proxy's exit address, once it has been checked"
                    },
                    "lastCheck": {
                      "type": [
                        "object",
                        "null"
                      ],
                      "required": [
                        "ok",
                        "at"
                      ],
                      "properties": {
                        "ok": {
                          "type": "boolean"
                        },
                        "at": {
                          "type": "string",
                          "format": "date-time"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "proxies.delete",
        "summary": "Deletes a proxy. Pass the workspace as the workspaceId query parameter.",
        "description": "Deletes a proxy. Pass the workspace as the workspaceId query parameter.\n\nErrors this endpoint can answer: INVALID_PROXY_ID, INVALID_QUERY, PROXY_NOT_FOUND, CONFLICT, APP_NOT_READY, APP_TIMEOUT, APP_ERROR, FORBIDDEN, NOT_FOUND.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "The workspace the proxy belongs to"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/proxies/{id}/check": {
      "post": {
        "operationId": "proxies.check",
        "summary": "Tests the proxy connection now. Pass the workspace as the workspaceId query parameter.",
        "description": "Tests the proxy connection now. Pass the workspace as the workspaceId query parameter.\n\nErrors this endpoint can answer: INVALID_PROXY_ID, INVALID_QUERY, PROXY_NOT_FOUND, APP_NOT_READY, APP_TIMEOUT, APP_ERROR, FORBIDDEN, NOT_FOUND.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "The workspace the proxy belongs to"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "ok"
                  ],
                  "properties": {
                    "ok": {
                      "type": "boolean"
                    },
                    "latencyMs": {
                      "type": "integer"
                    },
                    "ip": {
                      "type": "string",
                      "description": "The address the proxy exits from"
                    },
                    "country": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/tags": {
      "get": {
        "operationId": "tags.list",
        "summary": "The tags this account can use, a page at a time.",
        "description": "The tags this account can use, a page at a time.\n\nErrors this endpoint can answer: INVALID_PAGE, INVALID_PAGE_SIZE, APP_NOT_READY, APP_TIMEOUT, APP_ERROR, FORBIDDEN.",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "description": "Default 1"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Default 50"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "items",
                    "page",
                    "pageSize",
                    "total"
                  ],
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "name",
                          "createdAt"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string"
                          },
                          "createdAt": {
                            "type": "string",
                            "format": "date-time"
                          }
                        }
                      }
                    },
                    "page": {
                      "type": "integer"
                    },
                    "pageSize": {
                      "type": "integer"
                    },
                    "total": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "tags.create",
        "summary": "Creates a tag.",
        "description": "Creates a tag.\n\nErrors this endpoint can answer: INVALID_BODY, INVALID_REQUEST, CONFLICT, PLAN_LIMIT, APP_NOT_READY, APP_TIMEOUT, APP_ERROR, FORBIDDEN.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name"
                ],
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 50
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "createdAt"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string"
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/tags/{id}": {
      "delete": {
        "operationId": "tags.delete",
        "summary": "Deletes a tag and takes it off every profile that carries it.",
        "description": "Deletes a tag and takes it off every profile that carries it.\n\nErrors this endpoint can answer: INVALID_TAG_ID, TAG_NOT_FOUND, APP_NOT_READY, APP_TIMEOUT, APP_ERROR, FORBIDDEN.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/workspaces": {
      "get": {
        "operationId": "workspaces.list",
        "summary": "The workspaces this account belongs to, with its role in each, a page at a time.",
        "description": "The workspaces this account belongs to, with its role in each, a page at a time.\n\nErrors this endpoint can answer: INVALID_PAGE, INVALID_PAGE_SIZE, APP_NOT_READY, APP_TIMEOUT, APP_ERROR, FORBIDDEN.",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "description": "Default 1"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Default 50"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "items",
                    "page",
                    "pageSize",
                    "total"
                  ],
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "name",
                          "role",
                          "isDefault"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string"
                          },
                          "role": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "enum": [
                              "OWNER",
                              "ADMIN",
                              "MEMBER",
                              "VIEWER",
                              null
                            ]
                          },
                          "isDefault": {
                            "type": "boolean"
                          }
                        }
                      }
                    },
                    "page": {
                      "type": "integer"
                    },
                    "pageSize": {
                      "type": "integer"
                    },
                    "total": {
                      "type": "integer"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/{id}/cookies": {
      "post": {
        "operationId": "cookies.import",
        "summary": "Saves cookies onto a stopped profile, as importing a file in the profile's settings does. The browser takes them on the profile's next start. The body may be up to 2 MB.",
        "description": "Saves cookies onto a stopped profile, as importing a file in the profile's settings does. The browser takes them on the profile's next start. The body may be up to 2 MB.\n\nErrors this endpoint can answer: INVALID_PROFILE_ID, INVALID_BODY, INVALID_COOKIES, BODY_TOO_LARGE, PROFILE_RUNNING, PROFILE_NOT_FOUND, FORBIDDEN, NOT_FOUND, INVALID_REQUEST, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "type": "object",
                    "required": [
                      "format",
                      "cookies"
                    ],
                    "additionalProperties": false,
                    "properties": {
                      "format": {
                        "type": "string",
                        "enum": [
                          "json"
                        ]
                      },
                      "cookies": {
                        "type": "array",
                        "minItems": 1,
                        "maxItems": 5000,
                        "items": {
                          "type": "object",
                          "required": [
                            "name",
                            "domain"
                          ],
                          "properties": {
                            "name": {
                              "type": "string"
                            },
                            "value": {
                              "type": "string"
                            },
                            "domain": {
                              "type": "string"
                            },
                            "path": {
                              "type": "string"
                            },
                            "expires": {
                              "type": [
                                "number",
                                "null"
                              ],
                              "description": "Seconds since 1970; null for a cookie that ends with the browser session"
                            },
                            "httpOnly": {
                              "type": "boolean"
                            },
                            "secure": {
                              "type": "boolean"
                            },
                            "sameSite": {
                              "type": [
                                "string",
                                "null"
                              ],
                              "enum": [
                                "Strict",
                                "Lax",
                                "None",
                                null
                              ]
                            }
                          }
                        },
                        "description": "Each needs a name and a domain; path defaults to /, a missing expires makes a session cookie"
                      }
                    }
                  },
                  {
                    "type": "object",
                    "required": [
                      "format",
                      "text"
                    ],
                    "additionalProperties": false,
                    "properties": {
                      "format": {
                        "type": "string",
                        "enum": [
                          "netscape"
                        ]
                      },
                      "text": {
                        "type": "string",
                        "minLength": 1,
                        "description": "A Netscape cookies.txt file, at most 5000 cookies"
                      }
                    }
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "profileId",
                    "imported"
                  ],
                  "properties": {
                    "profileId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "imported": {
                      "type": "integer",
                      "minimum": 1
                    }
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "operationId": "cookies.export",
        "summary": "The cookies in the browser of a profile the API started and that still runs.",
        "description": "The cookies in the browser of a profile the API started and that still runs.\n\nErrors this endpoint can answer: INVALID_PROFILE_ID, NOT_RUNNING, RUNNING_WITHOUT_AUTOMATION.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "cookies"
                  ],
                  "properties": {
                    "cookies": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "name",
                          "value",
                          "domain",
                          "path",
                          "expires",
                          "httpOnly",
                          "secure",
                          "sameSite"
                        ],
                        "properties": {
                          "name": {
                            "type": "string"
                          },
                          "value": {
                            "type": "string"
                          },
                          "domain": {
                            "type": "string"
                          },
                          "path": {
                            "type": "string"
                          },
                          "expires": {
                            "type": [
                              "number",
                              "null"
                            ],
                            "description": "Seconds since 1970; null for a cookie that ends with the browser session"
                          },
                          "httpOnly": {
                            "type": "boolean"
                          },
                          "secure": {
                            "type": "boolean"
                          },
                          "sameSite": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "enum": [
                              "Strict",
                              "Lax",
                              "None",
                              null
                            ]
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "cookies.clear",
        "summary": "Removes the cookies saved onto the profile that its browser has not taken yet. Cookies already in the browser stay.",
        "description": "Removes the cookies saved onto the profile that its browser has not taken yet. Cookies already in the browser stay.\n\nErrors this endpoint can answer: INVALID_PROFILE_ID, PROFILE_NOT_FOUND, FORBIDDEN, NOT_FOUND, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "profileId"
                  ],
                  "properties": {
                    "profileId": {
                      "type": "string",
                      "format": "uuid"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles": {
      "get": {
        "operationId": "profiles.list",
        "summary": "The profiles this account can see, filtered and paged, with their state on this computer.",
        "description": "The profiles this account can see, filtered and paged, with their state on this computer.\n\nErrors this endpoint can answer: INVALID_PAGE, INVALID_PAGE_SIZE, INVALID_QUERY, INVALID_REQUEST, FORBIDDEN, PLAN_LIMIT, NOT_FOUND, CONFLICT, RATE_LIMITED, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "description": "Default 1"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "maximum": 100,
              "description": "Default 50"
            }
          },
          {
            "name": "workspaceId",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "format": "uuid",
              "description": "Only this workspace's profiles"
            }
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 100,
              "description": "Part of a profile name"
            }
          },
          {
            "name": "tag",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "maxLength": 100,
              "description": "A tag name"
            }
          },
          {
            "name": "state",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "stopped",
                "starting",
                "running",
                "stopping",
                "syncing"
              ],
              "description": "State on this computer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "items",
                    "page",
                    "pageSize",
                    "total",
                    "profiles"
                  ],
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "name",
                          "workspaceId",
                          "workspaceName",
                          "os",
                          "browser",
                          "running",
                          "state",
                          "notes",
                          "startUrl",
                          "proxyId",
                          "tags",
                          "createdAt"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string"
                          },
                          "workspaceId": {
                            "type": "string",
                            "format": "uuid",
                            "description": "The workspace this account reaches the profile through"
                          },
                          "workspaceName": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "os": {
                            "type": "string"
                          },
                          "browser": {
                            "type": "string"
                          },
                          "running": {
                            "type": "boolean",
                            "description": "true in every state but stopped"
                          },
                          "state": {
                            "type": "string",
                            "enum": [
                              "stopped",
                              "starting",
                              "running",
                              "stopping",
                              "syncing"
                            ],
                            "description": "On this computer"
                          },
                          "notes": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "startUrl": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "proxyId": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "format": "uuid"
                          },
                          "tags": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "createdAt": {
                            "type": "string",
                            "format": "date-time"
                          }
                        }
                      }
                    },
                    "page": {
                      "type": "integer",
                      "minimum": 1
                    },
                    "pageSize": {
                      "type": "integer",
                      "minimum": 1,
                      "maximum": 100,
                      "description": "Default 50"
                    },
                    "total": {
                      "type": "integer",
                      "description": "Profiles matching the filters, on every page"
                    },
                    "profiles": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "name",
                          "workspaceId",
                          "workspaceName",
                          "os",
                          "browser",
                          "running",
                          "state",
                          "notes",
                          "startUrl",
                          "proxyId",
                          "tags",
                          "createdAt"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string"
                          },
                          "workspaceId": {
                            "type": "string",
                            "format": "uuid",
                            "description": "The workspace this account reaches the profile through"
                          },
                          "workspaceName": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "os": {
                            "type": "string"
                          },
                          "browser": {
                            "type": "string"
                          },
                          "running": {
                            "type": "boolean",
                            "description": "true in every state but stopped"
                          },
                          "state": {
                            "type": "string",
                            "enum": [
                              "stopped",
                              "starting",
                              "running",
                              "stopping",
                              "syncing"
                            ],
                            "description": "On this computer"
                          },
                          "notes": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "startUrl": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "proxyId": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "format": "uuid"
                          },
                          "tags": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "createdAt": {
                            "type": "string",
                            "format": "date-time"
                          }
                        }
                      },
                      "deprecated": true,
                      "description": "Deprecated: use items. Every profile matching the filters, unpaged, as before FF-146"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "operationId": "profiles.create",
        "summary": "Creates a profile. A name alone makes a quick profile with a random device in the default workspace.",
        "description": "Creates a profile. A name alone makes a quick profile with a random device in the default workspace.\n\nErrors this endpoint can answer: INVALID_BODY, BROWSER_NOT_ON_OS, NO_WORKSPACE, INVALID_REQUEST, FORBIDDEN, PLAN_LIMIT, NOT_FOUND, CONFLICT, RATE_LIMITED, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "name"
                ],
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                  },
                  "workspaceId": {
                    "type": "string",
                    "format": "uuid",
                    "description": "Defaults to the account's default workspace"
                  },
                  "os": {
                    "type": "string",
                    "enum": [
                      "windows",
                      "macos",
                      "linux"
                    ],
                    "description": "Random when absent"
                  },
                  "browser": {
                    "type": "string",
                    "enum": [
                      "chrome",
                      "edge",
                      "opera"
                    ],
                    "description": "Random when absent; edge is not offered on linux"
                  },
                  "proxyId": {
                    "type": "string",
                    "format": "uuid",
                    "description": "A proxy of the same workspace"
                  },
                  "tags": {
                    "type": "array",
                    "maxItems": 20,
                    "items": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 50
                    },
                    "description": "Tag names"
                  },
                  "notes": {
                    "type": "string",
                    "maxLength": 5000
                  },
                  "startUrl": {
                    "type": "string",
                    "maxLength": 2048,
                    "pattern": "^https?://",
                    "description": "An http or https URL"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "workspaceId",
                    "workspaceName",
                    "os",
                    "browser",
                    "running",
                    "state",
                    "notes",
                    "startUrl",
                    "proxyId",
                    "tags",
                    "createdAt"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string"
                    },
                    "workspaceId": {
                      "type": "string",
                      "format": "uuid",
                      "description": "The workspace this account reaches the profile through"
                    },
                    "workspaceName": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "os": {
                      "type": "string"
                    },
                    "browser": {
                      "type": "string"
                    },
                    "running": {
                      "type": "boolean",
                      "description": "true in every state but stopped"
                    },
                    "state": {
                      "type": "string",
                      "enum": [
                        "stopped",
                        "starting",
                        "running",
                        "stopping",
                        "syncing"
                      ],
                      "description": "On this computer"
                    },
                    "notes": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "startUrl": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "proxyId": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "uuid"
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/batch": {
      "post": {
        "operationId": "profiles.batchCreate",
        "summary": "Creates count profiles from one body in one request; all of them are created or none is.",
        "description": "Creates count profiles from one body in one request; all of them are created or none is.\n\nErrors this endpoint can answer: INVALID_BODY, BROWSER_NOT_ON_OS, NO_WORKSPACE, INVALID_REQUEST, FORBIDDEN, PLAN_LIMIT, NOT_FOUND, CONFLICT, RATE_LIMITED, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "count",
                  "name"
                ],
                "additionalProperties": false,
                "properties": {
                  "count": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 50
                  },
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100,
                    "description": "{n} is replaced by the number from 1; without it the number is appended"
                  },
                  "workspaceId": {
                    "type": "string",
                    "format": "uuid",
                    "description": "Defaults to the account's default workspace"
                  },
                  "os": {
                    "type": "string",
                    "enum": [
                      "windows",
                      "macos",
                      "linux"
                    ],
                    "description": "Random when absent"
                  },
                  "browser": {
                    "type": "string",
                    "enum": [
                      "chrome",
                      "edge",
                      "opera"
                    ],
                    "description": "Random when absent; edge is not offered on linux"
                  },
                  "proxyId": {
                    "type": "string",
                    "format": "uuid",
                    "description": "A proxy of the same workspace"
                  },
                  "tags": {
                    "type": "array",
                    "maxItems": 20,
                    "items": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 50
                    },
                    "description": "Tag names"
                  },
                  "notes": {
                    "type": "string",
                    "maxLength": 5000
                  },
                  "startUrl": {
                    "type": "string",
                    "maxLength": 2048,
                    "pattern": "^https?://",
                    "description": "An http or https URL"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "created"
                  ],
                  "properties": {
                    "created": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "required": [
                          "id",
                          "name",
                          "workspaceId",
                          "workspaceName",
                          "os",
                          "browser",
                          "running",
                          "state",
                          "notes",
                          "startUrl",
                          "proxyId",
                          "tags",
                          "createdAt"
                        ],
                        "properties": {
                          "id": {
                            "type": "string",
                            "format": "uuid"
                          },
                          "name": {
                            "type": "string"
                          },
                          "workspaceId": {
                            "type": "string",
                            "format": "uuid",
                            "description": "The workspace this account reaches the profile through"
                          },
                          "workspaceName": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "os": {
                            "type": "string"
                          },
                          "browser": {
                            "type": "string"
                          },
                          "running": {
                            "type": "boolean",
                            "description": "true in every state but stopped"
                          },
                          "state": {
                            "type": "string",
                            "enum": [
                              "stopped",
                              "starting",
                              "running",
                              "stopping",
                              "syncing"
                            ],
                            "description": "On this computer"
                          },
                          "notes": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "startUrl": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "proxyId": {
                            "type": [
                              "string",
                              "null"
                            ],
                            "format": "uuid"
                          },
                          "tags": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          },
                          "createdAt": {
                            "type": "string",
                            "format": "date-time"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/{id}": {
      "get": {
        "operationId": "profiles.get",
        "summary": "One profile, with its state on this computer.",
        "description": "One profile, with its state on this computer.\n\nErrors this endpoint can answer: INVALID_PROFILE_ID, PROFILE_NOT_FOUND, INVALID_REQUEST, FORBIDDEN, PLAN_LIMIT, NOT_FOUND, CONFLICT, RATE_LIMITED, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "workspaceId",
                    "workspaceName",
                    "os",
                    "browser",
                    "running",
                    "state",
                    "notes",
                    "startUrl",
                    "proxyId",
                    "tags",
                    "createdAt"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string"
                    },
                    "workspaceId": {
                      "type": "string",
                      "format": "uuid",
                      "description": "The workspace this account reaches the profile through"
                    },
                    "workspaceName": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "os": {
                      "type": "string"
                    },
                    "browser": {
                      "type": "string"
                    },
                    "running": {
                      "type": "boolean",
                      "description": "true in every state but stopped"
                    },
                    "state": {
                      "type": "string",
                      "enum": [
                        "stopped",
                        "starting",
                        "running",
                        "stopping",
                        "syncing"
                      ],
                      "description": "On this computer"
                    },
                    "notes": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "startUrl": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "proxyId": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "uuid"
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "patch": {
        "operationId": "profiles.update",
        "summary": "Changes a profile's name, proxy, tags, notes or start page. Fields left out keep their value.",
        "description": "Changes a profile's name, proxy, tags, notes or start page. Fields left out keep their value.\n\nErrors this endpoint can answer: INVALID_PROFILE_ID, INVALID_BODY, PROFILE_NOT_FOUND, INVALID_REQUEST, FORBIDDEN, PLAN_LIMIT, NOT_FOUND, CONFLICT, RATE_LIMITED, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "required": false,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "description": "At least one field",
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 100
                  },
                  "proxyId": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "format": "uuid",
                    "description": "null removes the proxy"
                  },
                  "tags": {
                    "type": "array",
                    "maxItems": 20,
                    "items": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 50
                    },
                    "description": "Replaces every tag"
                  },
                  "notes": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "maxLength": 5000,
                    "description": "null clears them"
                  },
                  "startUrl": {
                    "type": [
                      "string",
                      "null"
                    ],
                    "maxLength": 2048,
                    "pattern": "^https?://",
                    "description": "null clears it"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "workspaceId",
                    "workspaceName",
                    "os",
                    "browser",
                    "running",
                    "state",
                    "notes",
                    "startUrl",
                    "proxyId",
                    "tags",
                    "createdAt"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string"
                    },
                    "workspaceId": {
                      "type": "string",
                      "format": "uuid",
                      "description": "The workspace this account reaches the profile through"
                    },
                    "workspaceName": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "os": {
                      "type": "string"
                    },
                    "browser": {
                      "type": "string"
                    },
                    "running": {
                      "type": "boolean",
                      "description": "true in every state but stopped"
                    },
                    "state": {
                      "type": "string",
                      "enum": [
                        "stopped",
                        "starting",
                        "running",
                        "stopping",
                        "syncing"
                      ],
                      "description": "On this computer"
                    },
                    "notes": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "startUrl": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "proxyId": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "uuid"
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "profiles.delete",
        "summary": "Moves the profile to the trash, as the app does. A profile reached through another workspace is only removed from it.",
        "description": "Moves the profile to the trash, as the app does. A profile reached through another workspace is only removed from it.\n\nErrors this endpoint can answer: INVALID_PROFILE_ID, PROFILE_NOT_FOUND, PROFILE_RUNNING, INVALID_REQUEST, FORBIDDEN, PLAN_LIMIT, NOT_FOUND, CONFLICT, RATE_LIMITED, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "profileId",
                    "movedToTrash"
                  ],
                  "properties": {
                    "profileId": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "movedToTrash": {
                      "type": "boolean",
                      "description": "false when the profile was only removed from a workspace it was shared to"
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "/v1/profiles/{id}/clone": {
      "post": {
        "operationId": "profiles.clone",
        "summary": "Copies the profile's settings into a new profile named like the app names a clone, for example \"Shop (1)\".",
        "description": "Copies the profile's settings into a new profile named like the app names a clone, for example \"Shop (1)\".\n\nErrors this endpoint can answer: INVALID_PROFILE_ID, PROFILE_NOT_FOUND, CLONE_UNAVAILABLE, INVALID_REQUEST, FORBIDDEN, PLAN_LIMIT, NOT_FOUND, CONFLICT, RATE_LIMITED, APP_NOT_READY, APP_TIMEOUT, APP_ERROR.",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "required": [
                    "id",
                    "name",
                    "workspaceId",
                    "workspaceName",
                    "os",
                    "browser",
                    "running",
                    "state",
                    "notes",
                    "startUrl",
                    "proxyId",
                    "tags",
                    "createdAt"
                  ],
                  "properties": {
                    "id": {
                      "type": "string",
                      "format": "uuid"
                    },
                    "name": {
                      "type": "string"
                    },
                    "workspaceId": {
                      "type": "string",
                      "format": "uuid",
                      "description": "The workspace this account reaches the profile through"
                    },
                    "workspaceName": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "os": {
                      "type": "string"
                    },
                    "browser": {
                      "type": "string"
                    },
                    "running": {
                      "type": "boolean",
                      "description": "true in every state but stopped"
                    },
                    "state": {
                      "type": "string",
                      "enum": [
                        "stopped",
                        "starting",
                        "running",
                        "stopping",
                        "syncing"
                      ],
                      "description": "On this computer"
                    },
                    "notes": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "startUrl": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "proxyId": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "format": "uuid"
                    },
                    "tags": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "createdAt": {
                      "type": "string",
                      "format": "date-time"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
