### List Download Links for Files in Archive

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a GET call with a requestId to get a list of download links for each file stored in an archive. Each link is returned on a new line.

```bash
https://offcloud.com/api/cloud/list/[requestId]
```

--------------------------------

### Login via Username and Password

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Example of logging into Offcloud.com using jQuery AJAX with username and password. This method is an alternative to API key authentication.

```JavaScript
$.ajax({
    url: 'https://offcloud.com/api/login',
    data: {username: 'test@test.com', password: 'test'},
    type: 'POST',
    crossDomain: true, // enable this
xhrFields: {
    withCredentials: true
},
    success: function(data) { console.log(data); },
    error: function() { console.log('Failed!'); }
});
```

--------------------------------

### Add URL for Instant Downloading

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Use this jQuery AJAX POST request to add a URL for instant downloading. Requires an API key passed as a GET parameter.

```JavaScript
$.ajax({
    url: 'https://offcloud.com/api/instant?key=VHK7OoGO57kH1JOO9VlNo8AdRVF0qLD8',
    data: {'url' : 'http://www.cnn.com'},
    type: 'POST',
    crossDomain: true, // enable this
xhrFields: {
    withCredentials: true
},
    success: function(data) { console.log(data); },
    error: function() { console.log('Failed!'); }
});
```

--------------------------------

### Retrieve Available Remote Accounts

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

This jQuery AJAX POST example retrieves a list of available remote accounts. An API key is required for authentication.

```JavaScript
$.ajax({
    url: 'https://offcloud.com/api/remote/accounts?key=VHK7OoGO57kH1JOO9VlNo8AdRVF0qLD8',
    data: { },
    type: 'POST',
    crossDomain: true, // enable this
xhrFields: {
    withCredentials: true
},
    success: function(data) { console.log(data); },
    error: function() { console.log('Failed!'); }
});
```

--------------------------------

### Retrieve List of Available Proxy Servers

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a POST call to get a list of available proxy servers. Returns a JSON array with server ID, name, and region.

```bash
https://offcloud.com/api/proxy?key=[api_key]
```

--------------------------------

### API Login Authentication Error Response

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Example JSON response when authentication via the login endpoint fails due to invalid credentials or format.

```json
{
  "error": "Please enter a valid email address."
}
```

--------------------------------

### API Login Authentication Success Response

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Example JSON response upon successful authentication via the login endpoint. This response includes the user's email and userId.

```json
{
  "email": "test@test.com",
  "userId": "53f89e52822c8bf413000008"
}
```

--------------------------------

### Retrieve Status of User's Cloud Download

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a POST call with a requestId to get the status of a user's cloud download. Returns download status or an error message.

```bash
https://offcloud.com/api/cloud/status?key=[api_key]
```

--------------------------------

### Retry Failed Cloud Download Request

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a GET request with a requestId to retry a failed cloud download. The server will return a confirmation or fail response in JSON.

```bash
https://offcloud.com/api/cloud/retry/[requestId]?key=[api_key]
```

--------------------------------

### Retry Failed Remote Download Request

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a GET request with a requestId to retry a failed remote download. The server will return a confirmation or fail response in JSON.

```bash
https://offcloud.com/api/remote/retry/[requestId]?key=[api_key]
```

--------------------------------

### Check Login Status

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a GET call to this URL to check if a user is logged in to Offcloud.com. The response indicates login status with a 'loggedIn' field.

```HTTP
https://offcloud.com/api/check
```

--------------------------------

### Explore Zipped Files or Folder Archives from Cloud

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a GET call with a requestId to explore zipped files or folder archives in your cloud history. Returns a JSON array of download links.

```bash
https://offcloud.com/api/cloud/explore/[requestId]
```

--------------------------------

### Retrieve List of User's Remote Accounts

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a POST call to get a list of the user's remote accounts. Returns a JSON array with account details like ID, type, username, status, and usage.

```bash
https://offcloud.com/api/remote/accounts?key=[api_key]
```

--------------------------------

### Retrieve Status of User's Remote Download

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a POST call with a requestId to get the status of a user's remote download. Returns the download status or an error message.

```bash
https://offcloud.com/api/remote/status?key=[api_key]
```

--------------------------------

### Submit URL for Instant Downloading

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Use this URL to submit a resource URL for instant downloading. Include your API key and the URL of the resource. An optional proxyId can be specified.

```text
https://offcloud.com/api/instant?key=[api_key]
```

--------------------------------

### Adding an URL for instant downloading

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Submits a URL to Offcloud for instant downloading. Optionally allows specifying a proxy server.

```APIDOC
## Adding an URL for instant downloading

### Description
Submits a URL to Offcloud for instant downloading. Optionally allows specifying a proxy server.

### Method
POST

### Endpoint
`https://offcloud.com/api/instant?key=[api_key]`

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.

#### Request Body
- **url** (string) - Required - URL of the resource to download.
- **proxyId** (string) - Optional - ID of the preferred proxy server.

### Response
#### Success Response (200)
- **requestId** (string) - The ID of the request.
- **fileName** (string) - The name of the requested file.
- **url** (string) - The URL for instant download.
- **site** (string) - The website name.
- **status** (string) - The status of the requested file (e.g., 'created').
- **originalLink** (string) - The link to the original file.
- **createdOn** (string) - The date and time when the request was processed.

#### Response Example
```json
{
  "requestId": "some_request_id",
  "fileName": "example.zip",
  "url": "https://offcloud.com/download/example.zip",
  "site": "example.com",
  "status": "created",
  "originalLink": "http://original.com/example.zip",
  "createdOn": "2023-10-27T10:00:00Z"
}
```

#### Error Response
- **not_available** (object) - Indicates that adding this URL is not available for the user, with reasons like 'premium', 'links', 'proxy', or 'video'.
- **error** (string) - A general error message if the request cannot be processed.
```

--------------------------------

### Add URL for Instant Downloading

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Adds a given URL to the Offcloud service for instant downloading. Requires an API key for authentication.

```APIDOC
## POST /api/instant

### Description
Adds a URL to Offcloud for instant downloading.

### Method
POST

### Endpoint
https://offcloud.com/api/instant

### Parameters
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

#### Request Body
- **url** (string) - Required - The URL to be downloaded.
```

--------------------------------

### Check Cache Information for BitTorrent Data

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a POST call with a list of info hashes to check if BitTorrent archives are ready for download. The 'hashes' parameter should be an array of info hashes.

```bash
https://offcloud.com/api/cache?key=[api_key]
```

--------------------------------

### Add URL for Remote Downloading

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a POST call to add a URL for remote downloading. Requires API key, URL, remote account ID, and optionally a Google Drive folder ID.

```bash
https://offcloud.com/api/remote?key=[api_key]
```

--------------------------------

### Instant Download Not Available Response

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

JSON response when an instant download is not available for the user due to addon limitations (premium, links, proxy, video).

```json
{
  "not_available": "premium"
}
```

--------------------------------

### Adding a URL for remote downloading

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Initiates a remote download for a given URL. Requires specifying the URL, remote account ID, and optionally a Google Drive folder ID for upload.

```APIDOC
## POST /api/remote

### Description
Adds a URL for remote downloading to Offcloud. You can specify a remote account and a target folder for the download.

### Method
POST

### Endpoint
`https://offcloud.com/api/remote?key=[api_key]`

### Parameters
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

#### Request Body
- **url** (string) - Required - The URL of the resource to download.
- **remoteOptionId** (string) - Required - The ID of the remote account to use for downloading.
- **folderId** (string) - Optional - The ID of the Google Drive folder to upload the content to.

### Response
#### Success Response (200)
- **requestId** (string) - The ID of the download request.
- **fileName** (string) - The name of the file to be downloaded.
- **site** (string) - The website from which the file is being downloaded.
- **status** (string) - The current status of the download (e.g., 'created', 'downloaded', 'error').
- **originalLink** (string) - The original URL of the file.
- **createdOn** (string) - The date and time when the request was processed.

#### Error Response (e.g., 400)
- **not_available** (object) - Indicates that the download is not available due to addon requirements (e.g., 'premium', 'links', 'proxy', 'video').
- **error** (string) - A general error message if the request cannot be processed.

### Request Example
```json
{
  "url": "http://example.com/somefile.zip",
  "remoteOptionId": "12345",
  "folderId": "abcdef12345"
}
```

### Response Example (Success)
```json
{
  "requestId": "req_abc123",
  "fileName": "somefile.zip",
  "site": "example.com",
  "status": "created",
  "originalLink": "http://example.com/somefile.zip",
  "createdOn": "2023-10-27T10:00:00Z"
}
```

### Response Example (Not Available)
```json
{
  "not_available": {
    "premium": "User must purchase a premium downloading addon for this download."
  }
}
```
```

--------------------------------

### Instant Download Success Response

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

JSON response indicating a successful submission for instant download. It provides details like requestId, fileName, download URL, and status.

```json
{
  "requestId": "some_id",
  "fileName": "example.zip",
  "url": "https://offcloud.com/download/example.zip",
  "site": "example.com",
  "status": "created",
  "originalLink": "http://original.com/file.zip",
  "createdOn": "2023-10-27T10:00:00Z"
}
```

--------------------------------

### Retrieving a list of available proxy servers

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Fetches a list of available proxy servers, including their ID, name, and region.

```APIDOC
## POST /api/proxy

### Description
Retrieves a list of available proxy servers that can be used for downloads.

### Method
POST

### Endpoint
`https://offcloud.com/api/proxy?key=[api_key]`

### Parameters
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the proxy server.
- **name** (string) - The name of the proxy server.
- **region** (string) - The geographical location of the proxy server.

### Response Example
```json
[
  {
    "id": "proxy_1",
    "name": "US East Proxy",
    "region": "us-east"
  },
  {
    "id": "proxy_2",
    "name": "Europe Proxy",
    "region": "eu-west"
  }
]
```
```

--------------------------------

### Adding an URL for cloud downloading

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Submits a URL to Offcloud for cloud downloading. The status can be checked later.

```APIDOC
## Adding an URL for cloud downloading

### Description
Submits a URL to Offcloud for cloud downloading. The status can be checked later.

### Method
POST

### Endpoint
`https://offcloud.com/api/cloud?key=[api_key]`

### Parameters
#### Query Parameters
- **key** (string) - Required - Your API key.

#### Request Body
- **url** (string) - Required - URL of the resource to download.

### Response
#### Success Response (200)
- **requestId** (string) - The ID of the request.
- **fileName** (string) - The name of the requested file.
- **url** (string) - The URL for download from the cloud.
- **site** (string) - The website name.
- **status** (string) - The status of the download (e.g., 'created', 'downloaded', 'error').
- **originalLink** (string) - The link to the original file.
- **createdOn** (string) - The date and time when the request was processed.

#### Response Example
```json
{
  "requestId": "some_request_id",
  "fileName": "example.zip",
  "url": "https://offcloud.com/cloud/example.zip",
  "site": "example.com",
  "status": "created",
  "originalLink": "http://original.com/example.zip",
  "createdOn": "2023-10-27T10:00:00Z"
}
```

#### Error Response
- **not_available** (object) - Indicates that adding this URL is not available for the user, with reasons like 'premium', 'links', 'proxy', 'cloud', or 'video'.
- **error** (string) - A general error message if the request cannot be processed.
```

--------------------------------

### Submit URL for Cloud Downloading

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Use this URL to submit a resource URL for cloud downloading. Include your API key and the URL of the resource. The status of the download can be checked separately.

```text
https://offcloud.com/api/cloud?key=[api_key]
```

--------------------------------

### Cloud Download Not Available Response

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

JSON response when a cloud download is not available for the user due to addon limitations (premium, links, proxy, cloud, video).

```json
{
  "not_available": "cloud"
}
```

--------------------------------

### Retrieving a list of user’s remote accounts

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Fetches a list of all remote accounts configured for the user, including account details and usage information.

```APIDOC
## POST /api/remote/accounts

### Description
Retrieves a list of all remote accounts configured for the user's Offcloud account.

### Method
POST

### Endpoint
`https://offcloud.com/api/remote/accounts?key=[api_key]`

### Parameters
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

### Response
#### Success Response (200)
- **accountId** (string) - The unique identifier for the remote account.
- **type** (string) - The type of the remote account (e.g., 'google_drive', 'dropbox').
- **username** (string) - The username associated with the remote account.
- **status** (string) - The current status of the remote account.
- **host** (string) - The host address of the remote account service.
- **port** (integer) - The port number for the remote account service.
- **usage** (string) - Information about the traffic usage for this remote account.

### Response Example
```json
[
  {
    "accountId": "acc_abc",
    "type": "google_drive",
    "username": "user@gmail.com",
    "status": "active",
    "host": "drive.google.com",
    "port": 443,
    "usage": "10GB / 100GB"
  }
]
```
```

--------------------------------

### Retrieve API Key

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Make a POST call to this URL to retrieve the API key and email of the logged-in user. This is useful for authenticated API interactions.

```HTTP
https://offcloud.com/api/key
```

--------------------------------

### Retrieve Available Remote Accounts

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Retrieves a list of available remote accounts that can be used with Offcloud. Requires an API key for authentication.

```APIDOC
## POST /api/remote/accounts

### Description
Retrieves a list of available remote accounts.

### Method
POST

### Endpoint
https://offcloud.com/api/remote/accounts

### Parameters
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

#### Request Body
- **data** (object) - Empty object, used to satisfy POST request structure.
```

--------------------------------

### Cloud Download Success Response

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

JSON response indicating a successful submission for cloud download. It includes details like requestId, fileName, cloud download URL, and status.

```json
{
  "requestId": "some_id",
  "fileName": "example.zip",
  "url": "https://offcloud.com/cloud/example.zip",
  "site": "example.com",
  "status": "created",
  "originalLink": "http://original.com/file.zip",
  "createdOn": "2023-10-27T10:00:00Z"
}
```

--------------------------------

### Listing files in a zipped file or folder archive from cloud

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Retrieves a list of download links for files within a zipped archive or folder in your cloud history, with one link per line.

```APIDOC
## GET /api/cloud/list/[requestId]

### Description
Retrieves a list of download links for each file stored in a zipped archive or folder in your cloud history. Each link is provided on a new line.

### Method
GET

### Endpoint
`https://offcloud.com/api/cloud/list/[requestId]`

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The ID of the archive to list.

### Response
#### Success Response (200)
- Returns a plain text response with each download link on a new line.

### Response Example
```
http://offcloud.com/download/file1.txt
http://offcloud.com/download/subdir/file2.jpg
```
```

--------------------------------

### Retrieve API Key

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Retrieves the API key associated with the currently logged-in user's session. Returns the user's email and their API key.

```APIDOC
## POST /api/key

### Description
Retrieves the API key for the currently logged-in user.

### Method
POST

### Endpoint
https://offcloud.com/api/key

### Response
#### Success Response (200)
- **email** (string) - The email address of the logged-in user.
- **apiKey** (string) - The API key of the currently authorized user.
```

--------------------------------

### Checking the cache information about BitTorrent data

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Checks if archives on the BitTorrent network are available for immediate download by providing a list of info hashes.

```APIDOC
## POST /api/cache

### Description
Checks the Offcloud cache for the availability of BitTorrent data based on provided info hashes.

### Method
POST

### Endpoint
`https://offcloud.com/api/cache?key=[api_key]`

### Parameters
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

#### Request Body
- **hashes** (array of strings) - Required - An array of BitTorrent info hashes for the content to check.

### Response
#### Success Response (200)
- **available** (array of strings) - A list of info hashes that are available in the cache for immediate download.
- **unavailable** (array of strings) - A list of info hashes that are not currently available in the cache.

### Response Example
```json
{
  "available": ["hash1", "hash3"],
  "unavailable": ["hash2"]
}
```
```

--------------------------------

### Authenticate to the Offcloud.com API

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Authenticates to the Offcloud API using either an API key or username/password. Successful authentication returns user details and a session cookie for subsequent requests.

```APIDOC
## Authenticate to the Offcloud.com API

### Description
Authenticates to the Offcloud API using either an API key or username/password. Successful authentication returns user details and a session cookie for subsequent requests.

### Method
POST

### Endpoint
`https://offcloud.com/api/login`

### Parameters
#### Request Body
- **username** (string) - Required - The e-mail of the registered user.
- **password** (string) - Required - The password of the registered user.

### Request Example
```json
{
  "username": "test@test.com",
  "password": "your_password"
}
```

### Response
#### Success Response (200)
- **email** (string) - The user's email address.
- **userId** (string) - The user's unique ID.

#### Response Example
```json
{
  "email": "test@test.com",
  "userId": "53f89e52822c8bf413000008"
}
```

#### Error Response
- **error** (string) - An error message if authentication fails.
```

--------------------------------

### Exploring zipped files or folder archives from cloud

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Retrieves a list of download links for files within a zipped archive or folder in your cloud history using its request ID.

```APIDOC
## GET /api/cloud/explore/[requestId]

### Description
Explores the contents of a zipped file or folder archive stored in your cloud history and returns download links for each file.

### Method
GET

### Endpoint
`https://offcloud.com/api/cloud/explore/[requestId]`

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The ID of the archive to explore.

### Response
#### Success Response (200)
- Returns a JSON array where each element is a download link to a file within the archive.

### Response Example
```json
[
  "http://offcloud.com/download/file1.txt",
  "http://offcloud.com/download/subdir/file2.jpg"
]
```
```

--------------------------------

### Retrieving a status of user’s cloud download

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Checks the status of a user's cloud download request using its unique request ID.

```APIDOC
## POST /api/cloud/status

### Description
Retrieves the status of a previously initiated cloud download request.

### Method
POST

### Endpoint
`https://offcloud.com/api/cloud/status?key=[api_key]`

### Parameters
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

#### Request Body
- **requestId** (string) - Required - The ID of the cloud download request to check.

### Response
#### Success Response (200)
- **status** (string) - The current status of the download (e.g., 'downloaded', 'processing', 'error').
- **message** (string) - Additional information about the status or any errors.

### Response Example
```json
{
  "status": "downloaded",
  "message": "File successfully downloaded."
}
```
```

--------------------------------

### API Authentication URL

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

The base URL for API requests, including the parameter for your API key. Alternatively, use the login endpoint for token-based authentication.

```text
https://offcloud.com/api/*?key=[api_key]
```

--------------------------------

### Check Login Status

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Checks if the user is currently logged in to Offcloud.com. Returns a JSON object indicating the login status.

```APIDOC
## GET /api/check

### Description
Checks the login status of the user on Offcloud.com.

### Method
GET

### Endpoint
https://offcloud.com/api/check

### Response
#### Success Response (200)
- **loggedIn** (integer) - 1 if user is logged in, else 0.
```

--------------------------------

### Retrying a failed cloud download request

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Attempts to retry a cloud download request that previously failed, using its request ID.

```APIDOC
## GET /api/cloud/retry/[requestId]

### Description
Retries a failed cloud download request.

### Method
GET

### Endpoint
`https://offcloud.com/api/cloud/retry/[requestId]?key=[api_key]`

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The ID of the failed cloud download request.
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

### Response
#### Success Response (200)
- Returns a JSON confirmation of the retry attempt or a failure response.

### Response Example
```json
{
  "success": true,
  "message": "Cloud download retry initiated."
}
```
```

--------------------------------

### Retrieving a status of user’s remote download

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Checks the status of a remote download request using its unique request ID.

```APIDOC
## POST /api/remote/status

### Description
Retrieves the status of a previously initiated remote download request.

### Method
POST

### Endpoint
`https://offcloud.com/api/remote/status?key=[api_key]`

### Parameters
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

#### Request Body
- **requestId** (string) - Required - The ID of the remote download request to check.

### Response
#### Success Response (200)
- **status** (string) - The current status of the download (e.g., 'completed', 'pending', 'failed').
- **message** (string) - Additional information about the status or any errors.

### Response Example
```json
{
  "status": "completed",
  "message": "Remote download finished successfully."
}
```
```

--------------------------------

### Retrying a failed remote download request

Source: https://github.com/offcloud/offcloud-api/blob/master/README.md

Attempts to retry a remote download request that previously failed, using its request ID.

```APIDOC
## GET /api/remote/retry/[requestId]

### Description
Retries a failed remote download request.

### Method
GET

### Endpoint
`https://offcloud.com/api/remote/retry/[requestId]?key=[api_key]`

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The ID of the failed remote download request.
#### Query Parameters
- **key** (string) - Required - Your Offcloud API key.

### Response
#### Success Response (200)
- Returns a JSON confirmation of the retry attempt or a failure response.

### Response Example
```json
{
  "success": true,
  "message": "Remote download retry initiated."
}
```
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.