Floatplane REST API

AuthV2

checkFor2faLogin

Check For 2FA Login

Complete the login process if a two-factor authentication token is required from the beginning of the login process.


/api/v2/auth/checkFor2faLogin

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v2/auth/checkFor2faLogin" \
 -d '{
  "token" : "token"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV2Api;

import java.io.File;
import java.util.*;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthV2Api apiInstance = new AuthV2Api();
        CheckFor2faLoginRequest checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest | 

        try {
            AuthLoginV2Response result = apiInstance.checkFor2faLogin(checkFor2faLoginRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#checkFor2faLogin");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV2Api;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        AuthV2Api apiInstance = new AuthV2Api();
        CheckFor2faLoginRequest checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest | 

        try {
            AuthLoginV2Response result = apiInstance.checkFor2faLogin(checkFor2faLoginRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#checkFor2faLogin");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AuthV2Api *apiInstance = [[AuthV2Api alloc] init];
CheckFor2faLoginRequest *checkFor2faLoginRequest = {"token":"123456"}; // 

// Check For 2FA Login
[apiInstance checkFor2faLoginWith:checkFor2faLoginRequest
              completionHandler: ^(AuthLoginV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV2Api()
var checkFor2faLoginRequest = {"token":"123456"}; // {CheckFor2faLoginRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.checkFor2faLogin(checkFor2faLoginRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class checkFor2faLoginExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AuthV2Api();
            var checkFor2faLoginRequest = new CheckFor2faLoginRequest(); // CheckFor2faLoginRequest | 

            try {
                // Check For 2FA Login
                AuthLoginV2Response result = apiInstance.checkFor2faLogin(checkFor2faLoginRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV2Api.checkFor2faLogin: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV2Api();
$checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest | 

try {
    $result = $api_instance->checkFor2faLogin($checkFor2faLoginRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV2Api->checkFor2faLogin: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV2Api->new();
my $checkFor2faLoginRequest = WWW::OPenAPIClient::Object::CheckFor2faLoginRequest->new(); # CheckFor2faLoginRequest | 

eval {
    my $result = $api_instance->checkFor2faLogin(checkFor2faLoginRequest => $checkFor2faLoginRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV2Api->checkFor2faLogin: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthV2Api()
checkFor2faLoginRequest = {"token":"123456"} # CheckFor2faLoginRequest | 

try:
    # Check For 2FA Login
    api_response = api_instance.check_for2fa_login(checkFor2faLoginRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV2Api->checkFor2faLogin: %s\n" % e)
extern crate AuthV2Api;

pub fn main() {
    let checkFor2faLoginRequest = {"token":"123456"}; // CheckFor2faLoginRequest

    let mut context = AuthV2Api::Context::default();
    let result = client.checkFor2faLogin(checkFor2faLoginRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
checkFor2faLoginRequest *

Responses

Name Type Format Description
SetMinusCookie String Contains the cookie used in subsequent authenticated requests.

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


login

Login

Login to Floatplane with the provided username and password, retrieving the authentication/authorization cookie from the response for subsequent requests.


/api/v2/auth/login

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v2/auth/login" \
 -d '{
  "password" : "password",
  "captchaToken" : "captchaToken",
  "username" : "username"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV2Api;

import java.io.File;
import java.util.*;

public class AuthV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AuthV2Api apiInstance = new AuthV2Api();
        AuthLoginV2Request authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request | 

        try {
            AuthLoginV2Response result = apiInstance.login(authLoginV2Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#login");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV2Api;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        AuthV2Api apiInstance = new AuthV2Api();
        AuthLoginV2Request authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request | 

        try {
            AuthLoginV2Response result = apiInstance.login(authLoginV2Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#login");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthV2Api *apiInstance = [[AuthV2Api alloc] init];
AuthLoginV2Request *authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // 

// Login
[apiInstance loginWith:authLoginV2Request
              completionHandler: ^(AuthLoginV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV2Api()
var authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // {AuthLoginV2Request} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.login(authLoginV2Request, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class loginExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new AuthV2Api();
            var authLoginV2Request = new AuthLoginV2Request(); // AuthLoginV2Request | 

            try {
                // Login
                AuthLoginV2Response result = apiInstance.login(authLoginV2Request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV2Api.login: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV2Api();
$authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request | 

try {
    $result = $api_instance->login($authLoginV2Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV2Api->login: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV2Api;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV2Api->new();
my $authLoginV2Request = WWW::OPenAPIClient::Object::AuthLoginV2Request->new(); # AuthLoginV2Request | 

eval {
    my $result = $api_instance->login(authLoginV2Request => $authLoginV2Request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV2Api->login: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AuthV2Api()
authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."} # AuthLoginV2Request | 

try:
    # Login
    api_response = api_instance.login(authLoginV2Request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV2Api->login: %s\n" % e)
extern crate AuthV2Api;

pub fn main() {
    let authLoginV2Request = {"username":"my_username","password":"my_password","captchaToken":"..."}; // AuthLoginV2Request

    let mut context = AuthV2Api::Context::default();
    let result = client.login(authLoginV2Request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
authLoginV2Request *

Responses

Name Type Format Description
SetMinusCookie String Contains the cookie used in subsequent authenticated requests.

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


logout

Logout

Log out of Floatplane, invalidating the authentication/authorization cookie.


/api/v2/auth/logout

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: text/plain,application/json,text/html" \
 "https://www.floatplane.com/api/v2/auth/logout"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV2Api;

import java.io.File;
import java.util.*;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            'String' result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#logout");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV2Api;

public class AuthV2ApiExample {
    public static void main(String[] args) {
        AuthV2Api apiInstance = new AuthV2Api();

        try {
            'String' result = apiInstance.logout();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV2Api#logout");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
AuthV2Api *apiInstance = [[AuthV2Api alloc] init];

// Logout
[apiInstance logoutWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.logout(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class logoutExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new AuthV2Api();

            try {
                // Logout
                'String' result = apiInstance.logout();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV2Api.logout: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV2Api();

try {
    $result = $api_instance->logout();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV2Api->logout: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV2Api->new();

eval {
    my $result = $api_instance->logout();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV2Api->logout: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.AuthV2Api()

try:
    # Logout
    api_response = api_instance.logout()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV2Api->logout: %s\n" % e)
extern crate AuthV2Api;

pub fn main() {

    let mut context = AuthV2Api::Context::default();
    let result = client.logout(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
SetMinusCookie String Contains the cookie used in subsequent authenticated requests.

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


AuthV3

getCaptchaInfo

Get Captcha Info

Gets the site keys used for Google Recaptcha V2 and V3. These are useful when providing a captcha token when logging in or signing up.


/api/v3/auth/captcha/info

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/auth/captcha/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthV3Api;

import java.io.File;
import java.util.*;

public class AuthV3ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        AuthV3Api apiInstance = new AuthV3Api();

        try {
            GetCaptchaInfoResponse result = apiInstance.getCaptchaInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV3Api#getCaptchaInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthV3Api;

public class AuthV3ApiExample {
    public static void main(String[] args) {
        AuthV3Api apiInstance = new AuthV3Api();

        try {
            GetCaptchaInfoResponse result = apiInstance.getCaptchaInfo();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthV3Api#getCaptchaInfo");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
AuthV3Api *apiInstance = [[AuthV3Api alloc] init];

// Get Captcha Info
[apiInstance getCaptchaInfoWithCompletionHandler: 
              ^(GetCaptchaInfoResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');

// Create an instance of the API class
var api = new FloatplaneRestApi.AuthV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCaptchaInfo(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCaptchaInfoExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new AuthV3Api();

            try {
                // Get Captcha Info
                GetCaptchaInfoResponse result = apiInstance.getCaptchaInfo();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthV3Api.getCaptchaInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthV3Api();

try {
    $result = $api_instance->getCaptchaInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthV3Api->getCaptchaInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AuthV3Api;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AuthV3Api->new();

eval {
    my $result = $api_instance->getCaptchaInfo();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthV3Api->getCaptchaInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.AuthV3Api()

try:
    # Get Captcha Info
    api_response = api_instance.get_captcha_info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthV3Api->getCaptchaInfo: %s\n" % e)
extern crate AuthV3Api;

pub fn main() {

    let mut context = AuthV3Api::Context::default();
    let result = client.getCaptchaInfo(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CDNV2

getDeliveryInfo

Get Delivery Info

Given an video/audio attachment identifier, retrieves the information necessary to play, download, or livestream the video/audio at various quality levels.


/api/v2/cdn/delivery

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/cdn/delivery?type=type_example&guid=guid_example&creator=creator_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CDNV2Api;

import java.io.File;
import java.util.*;

public class CDNV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CDNV2Api apiInstance = new CDNV2Api();
        String type = type_example; // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
        String guid = guid_example; // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
        String creator = creator_example; // String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

        try {
            CdnDeliveryV2Response result = apiInstance.getDeliveryInfo(type, guid, creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CDNV2Api#getDeliveryInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CDNV2Api;

public class CDNV2ApiExample {
    public static void main(String[] args) {
        CDNV2Api apiInstance = new CDNV2Api();
        String type = type_example; // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
        String guid = guid_example; // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
        String creator = creator_example; // String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

        try {
            CdnDeliveryV2Response result = apiInstance.getDeliveryInfo(type, guid, creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CDNV2Api#getDeliveryInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CDNV2Api *apiInstance = [[CDNV2Api alloc] init];
String *type = type_example; // Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later. (default to null)
String *guid = guid_example; // The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied. (optional) (default to null)
String *creator = creator_example; // The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned. (optional) (default to null)

// Get Delivery Info
[apiInstance getDeliveryInfoWith:type
    guid:guid
    creator:creator
              completionHandler: ^(CdnDeliveryV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CDNV2Api()
var type = type_example; // {String} Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
var opts = {
  'guid': guid_example, // {String} The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
  'creator': creator_example // {String} The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryInfo(type, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeliveryInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CDNV2Api();
            var type = type_example;  // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later. (default to null)
            var guid = guid_example;  // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied. (optional)  (default to null)
            var creator = creator_example;  // String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned. (optional)  (default to null)

            try {
                // Get Delivery Info
                CdnDeliveryV2Response result = apiInstance.getDeliveryInfo(type, guid, creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CDNV2Api.getDeliveryInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CDNV2Api();
$type = type_example; // String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
$guid = guid_example; // String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
$creator = creator_example; // String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

try {
    $result = $api_instance->getDeliveryInfo($type, $guid, $creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CDNV2Api->getDeliveryInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CDNV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CDNV2Api->new();
my $type = type_example; # String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later.
my $guid = guid_example; # String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
my $creator = creator_example; # String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

eval {
    my $result = $api_instance->getDeliveryInfo(type => $type, guid => $guid, creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CDNV2Api->getDeliveryInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CDNV2Api()
type = type_example # String | Used to determine which kind of retrieval method is requested for the video.

- VOD = stream a Video On Demand
- AOD = stream Audio On Demand
- Live = Livestream the content
- Download = Download the content for the user to play later. (default to null)
guid = guid_example # String | The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied. (optional) (default to null)
creator = creator_example # String | The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned. (optional) (default to null)

try:
    # Get Delivery Info
    api_response = api_instance.get_delivery_info(type, guid=guid, creator=creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CDNV2Api->getDeliveryInfo: %s\n" % e)
extern crate CDNV2Api;

pub fn main() {
    let type = type_example; // String
    let guid = guid_example; // String
    let creator = creator_example; // String

    let mut context = CDNV2Api::Context::default();
    let result = client.getDeliveryInfo(type, guid, creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
type*
String
Used to determine which kind of retrieval method is requested for the video. - VOD = stream a Video On Demand - AOD = stream Audio On Demand - Live = Livestream the content - Download = Download the content for the user to play later.
Required
guid
String
The GUID of the attachment for a post, retrievable from the `videoAttachments` or `audioAttachments` object. Required when `type` is `vod`, `aod`, or `download`. Note: either this or `creator` must be supplied.
creator
String
The GUID of the creator for a livestream, retrievable from `CreatorModelV2.id`. Required when `type` is `live`. Note: either this or `guid` must be supplied. Note: for `vod` and `download`, including this `creator` parameter *will* cause an error to be returned.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CommentV3

dislikeComment

Dislike Comment

Dislike a comment on a blog post.


/api/v3/comment/dislike

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: text/plain,application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/comment/dislike" \
 -d '{
  "comment" : "comment",
  "blogPost" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

        try {
            'String' result = apiInstance.dislikeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#dislikeComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

        try {
            'String' result = apiInstance.dislikeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#dislikeComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
CommentLikeV3PostRequest *commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // 

// Dislike Comment
[apiInstance dislikeCommentWith:commentLikeV3PostRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // {CommentLikeV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dislikeComment(commentLikeV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dislikeCommentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var commentLikeV3PostRequest = new CommentLikeV3PostRequest(); // CommentLikeV3PostRequest | 

            try {
                // Dislike Comment
                'String' result = apiInstance.dislikeComment(commentLikeV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.dislikeComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

try {
    $result = $api_instance->dislikeComment($commentLikeV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->dislikeComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $commentLikeV3PostRequest = WWW::OPenAPIClient::Object::CommentLikeV3PostRequest->new(); # CommentLikeV3PostRequest | 

eval {
    my $result = $api_instance->dislikeComment(commentLikeV3PostRequest => $commentLikeV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->dislikeComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"} # CommentLikeV3PostRequest | 

try:
    # Dislike Comment
    api_response = api_instance.dislike_comment(commentLikeV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->dislikeComment: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest

    let mut context = CommentV3Api::Context::default();
    let result = client.dislikeComment(commentLikeV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentLikeV3PostRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCommentReplies

Get Comment Replies

Retrieve more replies from a comment.


/api/v3/comment/replies

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/comment/replies?comment=comment_example&blogPost=blogPost_example&limit=56&rid=rid_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        String comment = comment_example; // String | The identifer of the comment from which to retrieve replies.
        String blogPost = blogPost_example; // String | The identifer of the blog post the `comment` belongs to.
        Integer limit = 56; // Integer | How many replies to retrieve.
        String rid = rid_example; // String | The identifer of the last reply in the reply chain.

        try {
            array[CommentModel] result = apiInstance.getCommentReplies(comment, blogPost, limit, rid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getCommentReplies");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        String comment = comment_example; // String | The identifer of the comment from which to retrieve replies.
        String blogPost = blogPost_example; // String | The identifer of the blog post the `comment` belongs to.
        Integer limit = 56; // Integer | How many replies to retrieve.
        String rid = rid_example; // String | The identifer of the last reply in the reply chain.

        try {
            array[CommentModel] result = apiInstance.getCommentReplies(comment, blogPost, limit, rid);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getCommentReplies");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
String *comment = comment_example; // The identifer of the comment from which to retrieve replies. (default to null)
String *blogPost = blogPost_example; // The identifer of the blog post the `comment` belongs to. (default to null)
Integer *limit = 56; // How many replies to retrieve. (default to null)
String *rid = rid_example; // The identifer of the last reply in the reply chain. (default to null)

// Get Comment Replies
[apiInstance getCommentRepliesWith:comment
    blogPost:blogPost
    limit:limit
    rid:rid
              completionHandler: ^(array[CommentModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var comment = comment_example; // {String} The identifer of the comment from which to retrieve replies.
var blogPost = blogPost_example; // {String} The identifer of the blog post the `comment` belongs to.
var limit = 56; // {Integer} How many replies to retrieve.
var rid = rid_example; // {String} The identifer of the last reply in the reply chain.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCommentReplies(comment, blogPost, limit, rid, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCommentRepliesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var comment = comment_example;  // String | The identifer of the comment from which to retrieve replies. (default to null)
            var blogPost = blogPost_example;  // String | The identifer of the blog post the `comment` belongs to. (default to null)
            var limit = 56;  // Integer | How many replies to retrieve. (default to null)
            var rid = rid_example;  // String | The identifer of the last reply in the reply chain. (default to null)

            try {
                // Get Comment Replies
                array[CommentModel] result = apiInstance.getCommentReplies(comment, blogPost, limit, rid);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.getCommentReplies: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$comment = comment_example; // String | The identifer of the comment from which to retrieve replies.
$blogPost = blogPost_example; // String | The identifer of the blog post the `comment` belongs to.
$limit = 56; // Integer | How many replies to retrieve.
$rid = rid_example; // String | The identifer of the last reply in the reply chain.

try {
    $result = $api_instance->getCommentReplies($comment, $blogPost, $limit, $rid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->getCommentReplies: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $comment = comment_example; # String | The identifer of the comment from which to retrieve replies.
my $blogPost = blogPost_example; # String | The identifer of the blog post the `comment` belongs to.
my $limit = 56; # Integer | How many replies to retrieve.
my $rid = rid_example; # String | The identifer of the last reply in the reply chain.

eval {
    my $result = $api_instance->getCommentReplies(comment => $comment, blogPost => $blogPost, limit => $limit, rid => $rid);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->getCommentReplies: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
comment = comment_example # String | The identifer of the comment from which to retrieve replies. (default to null)
blogPost = blogPost_example # String | The identifer of the blog post the `comment` belongs to. (default to null)
limit = 56 # Integer | How many replies to retrieve. (default to null)
rid = rid_example # String | The identifer of the last reply in the reply chain. (default to null)

try:
    # Get Comment Replies
    api_response = api_instance.get_comment_replies(comment, blogPost, limit, rid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->getCommentReplies: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let comment = comment_example; // String
    let blogPost = blogPost_example; // String
    let limit = 56; // Integer
    let rid = rid_example; // String

    let mut context = CommentV3Api::Context::default();
    let result = client.getCommentReplies(comment, blogPost, limit, rid, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
comment*
String
The identifer of the comment from which to retrieve replies.
Required
blogPost*
String
The identifer of the blog post the `comment` belongs to.
Required
limit*
Integer
How many replies to retrieve.
Required
rid*
String
The identifer of the last reply in the reply chain.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getComments

Get Comments

Get comments for a blog post object. Note that replies to each comment tend to be limited to 3. The extra replies can be retrieved via `getCommentReplies`. The difference in `$response.body#/0/totalReplies` and `$response.body#/0/replies`'s length can determine if more comments need to be loaded.


/api/v3/comment

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/comment?blogPost=blogPost_example&limit=56&fetchAfter=fetchAfter_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        String blogPost = blogPost_example; // String | Which blog post to retrieve comments for.
        Integer limit = 56; // Integer | The maximum number of comments to return. This should be set to 20 by default.
        String fetchAfter = fetchAfter_example; // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

        try {
            array[CommentModel] result = apiInstance.getComments(blogPost, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getComments");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        String blogPost = blogPost_example; // String | Which blog post to retrieve comments for.
        Integer limit = 56; // Integer | The maximum number of comments to return. This should be set to 20 by default.
        String fetchAfter = fetchAfter_example; // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

        try {
            array[CommentModel] result = apiInstance.getComments(blogPost, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#getComments");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
String *blogPost = blogPost_example; // Which blog post to retrieve comments for. (default to null)
Integer *limit = 56; // The maximum number of comments to return. This should be set to 20 by default. (default to null)
String *fetchAfter = fetchAfter_example; // When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`. (optional) (default to null)

// Get Comments
[apiInstance getCommentsWith:blogPost
    limit:limit
    fetchAfter:fetchAfter
              completionHandler: ^(array[CommentModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var blogPost = blogPost_example; // {String} Which blog post to retrieve comments for.
var limit = 56; // {Integer} The maximum number of comments to return. This should be set to 20 by default.
var opts = {
  'fetchAfter': fetchAfter_example // {String} When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getComments(blogPost, limit, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCommentsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var blogPost = blogPost_example;  // String | Which blog post to retrieve comments for. (default to null)
            var limit = 56;  // Integer | The maximum number of comments to return. This should be set to 20 by default. (default to null)
            var fetchAfter = fetchAfter_example;  // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`. (optional)  (default to null)

            try {
                // Get Comments
                array[CommentModel] result = apiInstance.getComments(blogPost, limit, fetchAfter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.getComments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$blogPost = blogPost_example; // String | Which blog post to retrieve comments for.
$limit = 56; // Integer | The maximum number of comments to return. This should be set to 20 by default.
$fetchAfter = fetchAfter_example; // String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

try {
    $result = $api_instance->getComments($blogPost, $limit, $fetchAfter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->getComments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $blogPost = blogPost_example; # String | Which blog post to retrieve comments for.
my $limit = 56; # Integer | The maximum number of comments to return. This should be set to 20 by default.
my $fetchAfter = fetchAfter_example; # String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

eval {
    my $result = $api_instance->getComments(blogPost => $blogPost, limit => $limit, fetchAfter => $fetchAfter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->getComments: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
blogPost = blogPost_example # String | Which blog post to retrieve comments for. (default to null)
limit = 56 # Integer | The maximum number of comments to return. This should be set to 20 by default. (default to null)
fetchAfter = fetchAfter_example # String | When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`. (optional) (default to null)

try:
    # Get Comments
    api_response = api_instance.get_comments(blogPost, limit, fetchAfter=fetchAfter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->getComments: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let blogPost = blogPost_example; // String
    let limit = 56; // Integer
    let fetchAfter = fetchAfter_example; // String

    let mut context = CommentV3Api::Context::default();
    let result = client.getComments(blogPost, limit, fetchAfter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
blogPost*
String
Which blog post to retrieve comments for.
Required
limit*
Integer
The maximum number of comments to return. This should be set to 20 by default.
Required
fetchAfter
String
When loading more comments on a blog post, this is used to determine which which comments to skip. This is a GUID of the last comment from the previous call to `getComments`.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


likeComment

Like Comment

Like a comment on a blog post.


/api/v3/comment/like

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: text/plain,application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/comment/like" \
 -d '{
  "comment" : "comment",
  "blogPost" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

        try {
            'String' result = apiInstance.likeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#likeComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        CommentLikeV3PostRequest commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

        try {
            'String' result = apiInstance.likeComment(commentLikeV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#likeComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
CommentLikeV3PostRequest *commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // 

// Like Comment
[apiInstance likeCommentWith:commentLikeV3PostRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // {CommentLikeV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.likeComment(commentLikeV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class likeCommentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var commentLikeV3PostRequest = new CommentLikeV3PostRequest(); // CommentLikeV3PostRequest | 

            try {
                // Like Comment
                'String' result = apiInstance.likeComment(commentLikeV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.likeComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest | 

try {
    $result = $api_instance->likeComment($commentLikeV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->likeComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $commentLikeV3PostRequest = WWW::OPenAPIClient::Object::CommentLikeV3PostRequest->new(); # CommentLikeV3PostRequest | 

eval {
    my $result = $api_instance->likeComment(commentLikeV3PostRequest => $commentLikeV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->likeComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"} # CommentLikeV3PostRequest | 

try:
    # Like Comment
    api_response = api_instance.like_comment(commentLikeV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->likeComment: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let commentLikeV3PostRequest = {"comment":"6161935e24f43441325bb255","blogPost":"j7KjCaKrtV"}; // CommentLikeV3PostRequest

    let mut context = CommentV3Api::Context::default();
    let result = client.likeComment(commentLikeV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentLikeV3PostRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


postComment

Post Comment

Post a new comment to a blog post object.


/api/v3/comment

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/comment" \
 -d '{
  "text" : "text",
  "blogPost" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentV3Api;

import java.io.File;
import java.util.*;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CommentV3Api apiInstance = new CommentV3Api();
        CommentV3PostRequest commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest | 

        try {
            CommentV3PostResponse result = apiInstance.postComment(commentV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#postComment");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CommentV3Api;

public class CommentV3ApiExample {
    public static void main(String[] args) {
        CommentV3Api apiInstance = new CommentV3Api();
        CommentV3PostRequest commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest | 

        try {
            CommentV3PostResponse result = apiInstance.postComment(commentV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentV3Api#postComment");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CommentV3Api *apiInstance = [[CommentV3Api alloc] init];
CommentV3PostRequest *commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // 

// Post Comment
[apiInstance postCommentWith:commentV3PostRequest
              completionHandler: ^(CommentV3PostResponse output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CommentV3Api()
var commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // {CommentV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.postComment(commentV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class postCommentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CommentV3Api();
            var commentV3PostRequest = new CommentV3PostRequest(); // CommentV3PostRequest | 

            try {
                // Post Comment
                CommentV3PostResponse result = apiInstance.postComment(commentV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CommentV3Api.postComment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CommentV3Api();
$commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest | 

try {
    $result = $api_instance->postComment($commentV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentV3Api->postComment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CommentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CommentV3Api->new();
my $commentV3PostRequest = WWW::OPenAPIClient::Object::CommentV3PostRequest->new(); # CommentV3PostRequest | 

eval {
    my $result = $api_instance->postComment(commentV3PostRequest => $commentV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CommentV3Api->postComment: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CommentV3Api()
commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"} # CommentV3PostRequest | 

try:
    # Post Comment
    api_response = api_instance.post_comment(commentV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommentV3Api->postComment: %s\n" % e)
extern crate CommentV3Api;

pub fn main() {
    let commentV3PostRequest = {"blogPost":"j7KjCaKrtV","text":"This is the text of the comment being posted"}; // CommentV3PostRequest

    let mut context = CommentV3Api::Context::default();
    let result = client.postComment(commentV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
commentV3PostRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ConnectedAccountsV2

listConnections

List Connections

List the available 3rd party accounts for the user's profile.


/api/v2/connect/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/connect/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConnectedAccountsV2Api;

import java.io.File;
import java.util.*;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            array[ConnectedAccountModel] result = apiInstance.listConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#listConnections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ConnectedAccountsV2Api;

public class ConnectedAccountsV2ApiExample {
    public static void main(String[] args) {
        ConnectedAccountsV2Api apiInstance = new ConnectedAccountsV2Api();

        try {
            array[ConnectedAccountModel] result = apiInstance.listConnections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConnectedAccountsV2Api#listConnections");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ConnectedAccountsV2Api *apiInstance = [[ConnectedAccountsV2Api alloc] init];

// List Connections
[apiInstance listConnectionsWithCompletionHandler: 
              ^(array[ConnectedAccountModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ConnectedAccountsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listConnections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listConnectionsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ConnectedAccountsV2Api();

            try {
                // List Connections
                array[ConnectedAccountModel] result = apiInstance.listConnections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConnectedAccountsV2Api.listConnections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConnectedAccountsV2Api();

try {
    $result = $api_instance->listConnections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectedAccountsV2Api->listConnections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConnectedAccountsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConnectedAccountsV2Api->new();

eval {
    my $result = $api_instance->listConnections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConnectedAccountsV2Api->listConnections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ConnectedAccountsV2Api()

try:
    # List Connections
    api_response = api_instance.list_connections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConnectedAccountsV2Api->listConnections: %s\n" % e)
extern crate ConnectedAccountsV2Api;

pub fn main() {

    let mut context = ConnectedAccountsV2Api::Context::default();
    let result = client.listConnections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


ContentV3

dislikeContent

Dislike Content

Toggles the dislike status on a piece of content. If liked before, it will turn into a dislike. If disliked before, the dislike will be removed.


/api/v3/content/dislike

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/content/dislike" \
 -d '{
  "id" : "id",
  "contentType" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        ContentLikeV3Request contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

        try {
            array['String'] result = apiInstance.dislikeContent(contentLikeV3Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#dislikeContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        ContentLikeV3Request contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

        try {
            array['String'] result = apiInstance.dislikeContent(contentLikeV3Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#dislikeContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
ContentLikeV3Request *contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // 

// Dislike Content
[apiInstance dislikeContentWith:contentLikeV3Request
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // {ContentLikeV3Request} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.dislikeContent(contentLikeV3Request, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class dislikeContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var contentLikeV3Request = new ContentLikeV3Request(); // ContentLikeV3Request | 

            try {
                // Dislike Content
                array['String'] result = apiInstance.dislikeContent(contentLikeV3Request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.dislikeContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

try {
    $result = $api_instance->dislikeContent($contentLikeV3Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->dislikeContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $contentLikeV3Request = WWW::OPenAPIClient::Object::ContentLikeV3Request->new(); # ContentLikeV3Request | 

eval {
    my $result = $api_instance->dislikeContent(contentLikeV3Request => $contentLikeV3Request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->dislikeContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"} # ContentLikeV3Request | 

try:
    # Dislike Content
    api_response = api_instance.dislike_content(contentLikeV3Request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->dislikeContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request

    let mut context = ContentV3Api::Context::default();
    let result = client.dislikeContent(contentLikeV3Request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
contentLikeV3Request *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getBlogPost

Get Blog Post

Retrieve more details on a specific blog post object for viewing.


/api/v3/content/post

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/post?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the post to be retrieved.

        try {
            ContentPostV3Response result = apiInstance.getBlogPost(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getBlogPost");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the post to be retrieved.

        try {
            ContentPostV3Response result = apiInstance.getBlogPost(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getBlogPost");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The ID of the post to be retrieved. (default to null)

// Get Blog Post
[apiInstance getBlogPostWith:id
              completionHandler: ^(ContentPostV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The ID of the post to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getBlogPost(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getBlogPostExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The ID of the post to be retrieved. (default to null)

            try {
                // Get Blog Post
                ContentPostV3Response result = apiInstance.getBlogPost(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getBlogPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The ID of the post to be retrieved.

try {
    $result = $api_instance->getBlogPost($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getBlogPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The ID of the post to be retrieved.

eval {
    my $result = $api_instance->getBlogPost(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getBlogPost: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The ID of the post to be retrieved. (default to null)

try:
    # Get Blog Post
    api_response = api_instance.get_blog_post(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getBlogPost: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentV3Api::Context::default();
    let result = client.getBlogPost(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the post to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getContentTags

Get Content Tags

Retrieve all tags and the number of times the tags have been used for the specified creator(s).


/api/v3/content/tags

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/tags?creatorIds="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        array[String] creatorIds = ; // array[String] | The creator(s) to search by.

        try {
            map['String', 'Integer'] result = apiInstance.getContentTags(creatorIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getContentTags");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        array[String] creatorIds = ; // array[String] | The creator(s) to search by.

        try {
            map['String', 'Integer'] result = apiInstance.getContentTags(creatorIds);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getContentTags");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
array[String] *creatorIds = ; // The creator(s) to search by. (default to null)

// Get Content Tags
[apiInstance getContentTagsWith:creatorIds
              completionHandler: ^(map['String', 'Integer'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var creatorIds = ; // {array[String]} The creator(s) to search by.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContentTags(creatorIds, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getContentTagsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var creatorIds = new array[String](); // array[String] | The creator(s) to search by. (default to null)

            try {
                // Get Content Tags
                map['String', 'Integer'] result = apiInstance.getContentTags(creatorIds);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getContentTags: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$creatorIds = ; // array[String] | The creator(s) to search by.

try {
    $result = $api_instance->getContentTags($creatorIds);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getContentTags: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $creatorIds = []; # array[String] | The creator(s) to search by.

eval {
    my $result = $api_instance->getContentTags(creatorIds => $creatorIds);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getContentTags: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
creatorIds =  # array[String] | The creator(s) to search by. (default to null)

try:
    # Get Content Tags
    api_response = api_instance.get_content_tags(creatorIds)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getContentTags: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let creatorIds = ; // array[String]

    let mut context = ContentV3Api::Context::default();
    let result = client.getContentTags(creatorIds, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorIds*
array[String]
The creator(s) to search by.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorBlogPosts

Get Creator Blog Posts

Retrieve a paginated list of blog posts from a creator. Or search for blog posts from a creator. Example query: https://www.floatplane.com/api/v3/content/creator?id=59f94c0bdd241b70349eb72b&fromDate=2021-07-24T07:00:00.001Z&toDate=2022-07-27T06:59:59.099Z&hasVideo=true&hasAudio=true&hasPicture=false&hasText=false&fromDuration=1020&toDuration=9900&sort=DESC&search=thor&tags[0]=tjm


/api/v3/content/creator

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/creator?id=id_example&channel=channel_example&limit=56&fetchAfter=56&search=search_example&tags=&hasVideo=true&hasAudio=true&hasPicture=true&hasText=true&sort=sort_example&fromDuration=56&toDuration=56&fromDate=2022-07-24T07:00:00.001Z&toDate=2022-07-24T07:00:00.001Z"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The GUID of the creator to retrieve posts from.
        String channel = channel_example; // String | The id of a creator's specific channel from which to retrieve posts.
        Integer limit = 56; // Integer | The maximum number of posts to return.
        Integer fetchAfter = 56; // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
        String search = search_example; // String | Search filter to look for specific posts.
        array[String] tags = ; // array[String] | An array of tags to search against, possibly in addition to `search`.
        Boolean hasVideo = true; // Boolean | If true, include blog posts with video attachments.
        Boolean hasAudio = true; // Boolean | If true, include blog posts with audio attachments.
        Boolean hasPicture = true; // Boolean | If true, include blog posts with picture attachments.
        Boolean hasText = true; // Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
        String sort = sort_example; // String | `DESC` = Newest First. `ASC` = Oldest First.
        Integer fromDuration = 56; // Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
        Integer toDuration = 56; // Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
        Date fromDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or after this filter date.
        Date toDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or before this filter date.

        try {
            array[BlogPostModelV3] result = apiInstance.getCreatorBlogPosts(id, channel, limit, fetchAfter, search, tags, hasVideo, hasAudio, hasPicture, hasText, sort, fromDuration, toDuration, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The GUID of the creator to retrieve posts from.
        String channel = channel_example; // String | The id of a creator's specific channel from which to retrieve posts.
        Integer limit = 56; // Integer | The maximum number of posts to return.
        Integer fetchAfter = 56; // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
        String search = search_example; // String | Search filter to look for specific posts.
        array[String] tags = ; // array[String] | An array of tags to search against, possibly in addition to `search`.
        Boolean hasVideo = true; // Boolean | If true, include blog posts with video attachments.
        Boolean hasAudio = true; // Boolean | If true, include blog posts with audio attachments.
        Boolean hasPicture = true; // Boolean | If true, include blog posts with picture attachments.
        Boolean hasText = true; // Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
        String sort = sort_example; // String | `DESC` = Newest First. `ASC` = Oldest First.
        Integer fromDuration = 56; // Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
        Integer toDuration = 56; // Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
        Date fromDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or after this filter date.
        Date toDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or before this filter date.

        try {
            array[BlogPostModelV3] result = apiInstance.getCreatorBlogPosts(id, channel, limit, fetchAfter, search, tags, hasVideo, hasAudio, hasPicture, hasText, sort, fromDuration, toDuration, fromDate, toDate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The GUID of the creator to retrieve posts from. (default to null)
String *channel = channel_example; // The id of a creator's specific channel from which to retrieve posts. (optional) (default to null)
Integer *limit = 56; // The maximum number of posts to return. (optional) (default to null)
Integer *fetchAfter = 56; // The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. (optional) (default to null)
String *search = search_example; // Search filter to look for specific posts. (optional) (default to null)
array[String] *tags = ; // An array of tags to search against, possibly in addition to `search`. (optional) (default to null)
Boolean *hasVideo = true; // If true, include blog posts with video attachments. (optional) (default to null)
Boolean *hasAudio = true; // If true, include blog posts with audio attachments. (optional) (default to null)
Boolean *hasPicture = true; // If true, include blog posts with picture attachments. (optional) (default to null)
Boolean *hasText = true; // If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results. (optional) (default to null)
String *sort = sort_example; // `DESC` = Newest First. `ASC` = Oldest First. (optional) (default to null)
Integer *fromDuration = 56; // Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional) (default to null)
Integer *toDuration = 56; // Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional) (default to null)
Date *fromDate = 2022-07-24T07:00:00.001Z; // Include posts where the publication date is on or after this filter date. (optional) (default to null)
Date *toDate = 2022-07-24T07:00:00.001Z; // Include posts where the publication date is on or before this filter date. (optional) (default to null)

// Get Creator Blog Posts
[apiInstance getCreatorBlogPostsWith:id
    channel:channel
    limit:limit
    fetchAfter:fetchAfter
    search:search
    tags:tags
    hasVideo:hasVideo
    hasAudio:hasAudio
    hasPicture:hasPicture
    hasText:hasText
    sort:sort
    fromDuration:fromDuration
    toDuration:toDuration
    fromDate:fromDate
    toDate:toDate
              completionHandler: ^(array[BlogPostModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The GUID of the creator to retrieve posts from.
var opts = {
  'channel': channel_example, // {String} The id of a creator's specific channel from which to retrieve posts.
  'limit': 56, // {Integer} The maximum number of posts to return.
  'fetchAfter': 56, // {Integer} The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
  'search': search_example, // {String} Search filter to look for specific posts.
  'tags': , // {array[String]} An array of tags to search against, possibly in addition to `search`.
  'hasVideo': true, // {Boolean} If true, include blog posts with video attachments.
  'hasAudio': true, // {Boolean} If true, include blog posts with audio attachments.
  'hasPicture': true, // {Boolean} If true, include blog posts with picture attachments.
  'hasText': true, // {Boolean} If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
  'sort': sort_example, // {String} `DESC` = Newest First. `ASC` = Oldest First.
  'fromDuration': 56, // {Integer} Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
  'toDuration': 56, // {Integer} Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
  'fromDate': 2022-07-24T07:00:00.001Z, // {Date} Include posts where the publication date is on or after this filter date.
  'toDate': 2022-07-24T07:00:00.001Z // {Date} Include posts where the publication date is on or before this filter date.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorBlogPosts(id, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorBlogPostsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The GUID of the creator to retrieve posts from. (default to null)
            var channel = channel_example;  // String | The id of a creator's specific channel from which to retrieve posts. (optional)  (default to null)
            var limit = 56;  // Integer | The maximum number of posts to return. (optional)  (default to null)
            var fetchAfter = 56;  // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. (optional)  (default to null)
            var search = search_example;  // String | Search filter to look for specific posts. (optional)  (default to null)
            var tags = new array[String](); // array[String] | An array of tags to search against, possibly in addition to `search`. (optional)  (default to null)
            var hasVideo = true;  // Boolean | If true, include blog posts with video attachments. (optional)  (default to null)
            var hasAudio = true;  // Boolean | If true, include blog posts with audio attachments. (optional)  (default to null)
            var hasPicture = true;  // Boolean | If true, include blog posts with picture attachments. (optional)  (default to null)
            var hasText = true;  // Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results. (optional)  (default to null)
            var sort = sort_example;  // String | `DESC` = Newest First. `ASC` = Oldest First. (optional)  (default to null)
            var fromDuration = 56;  // Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional)  (default to null)
            var toDuration = 56;  // Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional)  (default to null)
            var fromDate = 2022-07-24T07:00:00.001Z;  // Date | Include posts where the publication date is on or after this filter date. (optional)  (default to null)
            var toDate = 2022-07-24T07:00:00.001Z;  // Date | Include posts where the publication date is on or before this filter date. (optional)  (default to null)

            try {
                // Get Creator Blog Posts
                array[BlogPostModelV3] result = apiInstance.getCreatorBlogPosts(id, channel, limit, fetchAfter, search, tags, hasVideo, hasAudio, hasPicture, hasText, sort, fromDuration, toDuration, fromDate, toDate);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getCreatorBlogPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The GUID of the creator to retrieve posts from.
$channel = channel_example; // String | The id of a creator's specific channel from which to retrieve posts.
$limit = 56; // Integer | The maximum number of posts to return.
$fetchAfter = 56; // Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
$search = search_example; // String | Search filter to look for specific posts.
$tags = ; // array[String] | An array of tags to search against, possibly in addition to `search`.
$hasVideo = true; // Boolean | If true, include blog posts with video attachments.
$hasAudio = true; // Boolean | If true, include blog posts with audio attachments.
$hasPicture = true; // Boolean | If true, include blog posts with picture attachments.
$hasText = true; // Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
$sort = sort_example; // String | `DESC` = Newest First. `ASC` = Oldest First.
$fromDuration = 56; // Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
$toDuration = 56; // Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
$fromDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or after this filter date.
$toDate = 2022-07-24T07:00:00.001Z; // Date | Include posts where the publication date is on or before this filter date.

try {
    $result = $api_instance->getCreatorBlogPosts($id, $channel, $limit, $fetchAfter, $search, $tags, $hasVideo, $hasAudio, $hasPicture, $hasText, $sort, $fromDuration, $toDuration, $fromDate, $toDate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getCreatorBlogPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The GUID of the creator to retrieve posts from.
my $channel = channel_example; # String | The id of a creator's specific channel from which to retrieve posts.
my $limit = 56; # Integer | The maximum number of posts to return.
my $fetchAfter = 56; # Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
my $search = search_example; # String | Search filter to look for specific posts.
my $tags = []; # array[String] | An array of tags to search against, possibly in addition to `search`.
my $hasVideo = true; # Boolean | If true, include blog posts with video attachments.
my $hasAudio = true; # Boolean | If true, include blog posts with audio attachments.
my $hasPicture = true; # Boolean | If true, include blog posts with picture attachments.
my $hasText = true; # Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
my $sort = sort_example; # String | `DESC` = Newest First. `ASC` = Oldest First.
my $fromDuration = 56; # Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
my $toDuration = 56; # Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
my $fromDate = 2022-07-24T07:00:00.001Z; # Date | Include posts where the publication date is on or after this filter date.
my $toDate = 2022-07-24T07:00:00.001Z; # Date | Include posts where the publication date is on or before this filter date.

eval {
    my $result = $api_instance->getCreatorBlogPosts(id => $id, channel => $channel, limit => $limit, fetchAfter => $fetchAfter, search => $search, tags => $tags, hasVideo => $hasVideo, hasAudio => $hasAudio, hasPicture => $hasPicture, hasText => $hasText, sort => $sort, fromDuration => $fromDuration, toDuration => $toDuration, fromDate => $fromDate, toDate => $toDate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getCreatorBlogPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The GUID of the creator to retrieve posts from. (default to null)
channel = channel_example # String | The id of a creator's specific channel from which to retrieve posts. (optional) (default to null)
limit = 56 # Integer | The maximum number of posts to return. (optional) (default to null)
fetchAfter = 56 # Integer | The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results. (optional) (default to null)
search = search_example # String | Search filter to look for specific posts. (optional) (default to null)
tags =  # array[String] | An array of tags to search against, possibly in addition to `search`. (optional) (default to null)
hasVideo = true # Boolean | If true, include blog posts with video attachments. (optional) (default to null)
hasAudio = true # Boolean | If true, include blog posts with audio attachments. (optional) (default to null)
hasPicture = true # Boolean | If true, include blog posts with picture attachments. (optional) (default to null)
hasText = true # Boolean | If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery.

This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results. (optional) (default to null)
sort = sort_example # String | `DESC` = Newest First. `ASC` = Oldest First. (optional) (default to null)
fromDuration = 56 # Integer | Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional) (default to null)
toDuration = 56 # Integer | Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`. (optional) (default to null)
fromDate = 2022-07-24T07:00:00.001Z # Date | Include posts where the publication date is on or after this filter date. (optional) (default to null)
toDate = 2022-07-24T07:00:00.001Z # Date | Include posts where the publication date is on or before this filter date. (optional) (default to null)

try:
    # Get Creator Blog Posts
    api_response = api_instance.get_creator_blog_posts(id, channel=channel, limit=limit, fetchAfter=fetchAfter, search=search, tags=tags, hasVideo=hasVideo, hasAudio=hasAudio, hasPicture=hasPicture, hasText=hasText, sort=sort, fromDuration=fromDuration, toDuration=toDuration, fromDate=fromDate, toDate=toDate)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getCreatorBlogPosts: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String
    let channel = channel_example; // String
    let limit = 56; // Integer
    let fetchAfter = 56; // Integer
    let search = search_example; // String
    let tags = ; // array[String]
    let hasVideo = true; // Boolean
    let hasAudio = true; // Boolean
    let hasPicture = true; // Boolean
    let hasText = true; // Boolean
    let sort = sort_example; // String
    let fromDuration = 56; // Integer
    let toDuration = 56; // Integer
    let fromDate = 2022-07-24T07:00:00.001Z; // Date
    let toDate = 2022-07-24T07:00:00.001Z; // Date

    let mut context = ContentV3Api::Context::default();
    let result = client.getCreatorBlogPosts(id, channel, limit, fetchAfter, search, tags, hasVideo, hasAudio, hasPicture, hasText, sort, fromDuration, toDuration, fromDate, toDate, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the creator to retrieve posts from.
Required
channel
String
The id of a creator's specific channel from which to retrieve posts.
limit
Integer
The maximum number of posts to return.
fetchAfter
Integer
The number of posts to skip. Usually a multiple of `limit`, to get the next "page" of results.
search
tags
array[String]
An array of tags to search against, possibly in addition to `search`.
hasVideo
Boolean
If true, include blog posts with video attachments.
hasAudio
Boolean
If true, include blog posts with audio attachments.
hasPicture
Boolean
If true, include blog posts with picture attachments.
hasText
Boolean
If true, only include blog posts that are text-only. Text-only posts are ones without any attachments, such as video, audio, picture, and gallery. This filter and `hasVideo`, `hasAudio`, and `hasPicture` should be mutually exclusive. That is, if `hasText` is true then the other three should all be false. Conversely, if any of the other three are true, then `hasText` should be false. Otherwise, the filter would produce no results.
sort
String
`DESC` = Newest First. `ASC` = Oldest First.
fromDuration
Integer
Include video posts where the duration of the video is at minimum `fromDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
toDuration
Integer
Include video posts where the duration of the video is at maximum `toDuration` seconds long. Usually in multiples of 60 seconds. Implies `hasVideo=true`.
fromDate
Date (date-time)
Include posts where the publication date is on or after this filter date.
toDate
Date (date-time)
Include posts where the publication date is on or before this filter date.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getMultiCreatorBlogPosts

Get Multi Creator Blog Posts

Retrieve paginated blog posts from multiple creators for the home page. Example query: https://www.floatplane.com/api/v3/content/creator/list?ids[0]=59f94c0bdd241b70349eb72b&limit=20&fetchAfter[0][creatorId]=59f94c0bdd241b70349eb72b&fetchAfter[0][blogPostId]=B4WsyLnybS&fetchAfter[0][moreFetchable]=true


/api/v3/content/creator/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/creator/list?ids=&limit=56&fetchAfter="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        array[String] ids = ; // array[String] | The GUID(s) of the creator(s) to retrieve posts from.
        Integer limit = 56; // Integer | The maximum number of posts to retrieve.
        array[ContentCreatorListLastItems] fetchAfter = ; // array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

        try {
            ContentCreatorListV3Response result = apiInstance.getMultiCreatorBlogPosts(ids, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getMultiCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        array[String] ids = ; // array[String] | The GUID(s) of the creator(s) to retrieve posts from.
        Integer limit = 56; // Integer | The maximum number of posts to retrieve.
        array[ContentCreatorListLastItems] fetchAfter = ; // array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

        try {
            ContentCreatorListV3Response result = apiInstance.getMultiCreatorBlogPosts(ids, limit, fetchAfter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getMultiCreatorBlogPosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
array[String] *ids = ; // The GUID(s) of the creator(s) to retrieve posts from. (default to null)
Integer *limit = 56; // The maximum number of posts to retrieve. (default to null)
array[ContentCreatorListLastItems] *fetchAfter = ; // For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`. (optional) (default to null)

// Get Multi Creator Blog Posts
[apiInstance getMultiCreatorBlogPostsWith:ids
    limit:limit
    fetchAfter:fetchAfter
              completionHandler: ^(ContentCreatorListV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var ids = ; // {array[String]} The GUID(s) of the creator(s) to retrieve posts from.
var limit = 56; // {Integer} The maximum number of posts to retrieve.
var opts = {
  'fetchAfter':  // {array[ContentCreatorListLastItems]} For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getMultiCreatorBlogPosts(ids, limit, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getMultiCreatorBlogPostsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var ids = new array[String](); // array[String] | The GUID(s) of the creator(s) to retrieve posts from. (default to null)
            var limit = 56;  // Integer | The maximum number of posts to retrieve. (default to null)
            var fetchAfter = new array[ContentCreatorListLastItems](); // array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`. (optional)  (default to null)

            try {
                // Get Multi Creator Blog Posts
                ContentCreatorListV3Response result = apiInstance.getMultiCreatorBlogPosts(ids, limit, fetchAfter);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getMultiCreatorBlogPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$ids = ; // array[String] | The GUID(s) of the creator(s) to retrieve posts from.
$limit = 56; // Integer | The maximum number of posts to retrieve.
$fetchAfter = ; // array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

try {
    $result = $api_instance->getMultiCreatorBlogPosts($ids, $limit, $fetchAfter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getMultiCreatorBlogPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $ids = []; # array[String] | The GUID(s) of the creator(s) to retrieve posts from.
my $limit = 56; # Integer | The maximum number of posts to retrieve.
my $fetchAfter = []; # array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

eval {
    my $result = $api_instance->getMultiCreatorBlogPosts(ids => $ids, limit => $limit, fetchAfter => $fetchAfter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getMultiCreatorBlogPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
ids =  # array[String] | The GUID(s) of the creator(s) to retrieve posts from. (default to null)
limit = 56 # Integer | The maximum number of posts to retrieve. (default to null)
fetchAfter =  # array[ContentCreatorListLastItems] | For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`. (optional) (default to null)

try:
    # Get Multi Creator Blog Posts
    api_response = api_instance.get_multi_creator_blog_posts(ids, limit, fetchAfter=fetchAfter)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getMultiCreatorBlogPosts: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let ids = ; // array[String]
    let limit = 56; // Integer
    let fetchAfter = ; // array[ContentCreatorListLastItems]

    let mut context = ContentV3Api::Context::default();
    let result = client.getMultiCreatorBlogPosts(ids, limit, fetchAfter, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
ids*
array[String]
The GUID(s) of the creator(s) to retrieve posts from.
Required
limit*
Integer
The maximum number of posts to retrieve.
Required
fetchAfter
array[ContentCreatorListLastItems]
For pagination, this is used to determine which posts to skip. There should be one `fetchAfter` object for each creator in `ids`. The `moreFetchable` in the request, and all of the data, comes from the `ContentCreatorListV3Response`.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getPictureContent

Get Picture Content

Retrieve more information on a picture attachment from a blog post in order to consume the picture content.


/api/v3/content/picture

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/picture?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the picture attachment object, from the `BlogPostModelV3`.

        try {
            ContentPictureV3Response result = apiInstance.getPictureContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getPictureContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the picture attachment object, from the `BlogPostModelV3`.

        try {
            ContentPictureV3Response result = apiInstance.getPictureContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getPictureContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The ID of the picture attachment object, from the `BlogPostModelV3`. (default to null)

// Get Picture Content
[apiInstance getPictureContentWith:id
              completionHandler: ^(ContentPictureV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The ID of the picture attachment object, from the `BlogPostModelV3`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPictureContent(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getPictureContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The ID of the picture attachment object, from the `BlogPostModelV3`. (default to null)

            try {
                // Get Picture Content
                ContentPictureV3Response result = apiInstance.getPictureContent(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getPictureContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The ID of the picture attachment object, from the `BlogPostModelV3`.

try {
    $result = $api_instance->getPictureContent($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getPictureContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The ID of the picture attachment object, from the `BlogPostModelV3`.

eval {
    my $result = $api_instance->getPictureContent(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getPictureContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The ID of the picture attachment object, from the `BlogPostModelV3`. (default to null)

try:
    # Get Picture Content
    api_response = api_instance.get_picture_content(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getPictureContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentV3Api::Context::default();
    let result = client.getPictureContent(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the picture attachment object, from the `BlogPostModelV3`.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getProgress

Get Progress

Batch retrieval of watch progress values for blog posts. This API is useful for showing progress of a list of blog posts shown on the screen to the user. When retrieving a list of blog posts, the media attachments only include the identifier; when retrieving full details of a blog post, the attachments include more information, but still fail to return the progress of the media. Only when pulling the full video/audio content does the progress get included in the response. Thus, the recommended approach is to pull paginated results of blog posts first, as usual, and then to call this endpoint to retrieve progress values for each blog post to show in some capacity, usually on the thumbnail as a progress bar on the bottom. Note that the progress values returned in this endpoint are different from the update progress endpoint and the values returned in video/audio attachments. While the latter are measured in seconds, this endpoint returns progress as a percentage of the media's total duration. It is presumed that the progress returned is from the first attachment in the blog post's `attachmentOrder` that is either a video or audio attachment. Because this returns progress as an integer percentage (0 to 100), it is not recommended to use this particular value for jumping to a timestamp in the media when resuming playback, as the rounded number may be off by plus/minus several seconds in actual playback. Use the actual attachment progress, measured in seconds, instead.


/api/v3/content/get/progress

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/content/get/progress" \
 -d '{
  "ids" : [ "ids", "ids" ],
  "contentType" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        GetProgressRequest getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // GetProgressRequest | 

        try {
            array[GetProgressResponse_inner] result = apiInstance.getProgress(getProgressRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getProgress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        GetProgressRequest getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // GetProgressRequest | 

        try {
            array[GetProgressResponse_inner] result = apiInstance.getProgress(getProgressRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getProgress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
GetProgressRequest *getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // 

// Get Progress
[apiInstance getProgressWith:getProgressRequest
              completionHandler: ^(array[GetProgressResponse_inner] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // {GetProgressRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getProgress(getProgressRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getProgressExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var getProgressRequest = new GetProgressRequest(); // GetProgressRequest | 

            try {
                // Get Progress
                array[GetProgressResponse_inner] result = apiInstance.getProgress(getProgressRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getProgress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // GetProgressRequest | 

try {
    $result = $api_instance->getProgress($getProgressRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getProgress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $getProgressRequest = WWW::OPenAPIClient::Object::GetProgressRequest->new(); # GetProgressRequest | 

eval {
    my $result = $api_instance->getProgress(getProgressRequest => $getProgressRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getProgress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"} # GetProgressRequest | 

try:
    # Get Progress
    api_response = api_instance.get_progress(getProgressRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getProgress: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let getProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // GetProgressRequest

    let mut context = ContentV3Api::Context::default();
    let result = client.getProgress(getProgressRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
getProgressRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getRelatedBlogPosts

Get Related Blog Posts

Retrieve a list of blog posts that are related to the post being viewed.


/api/v3/content/related

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/related?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the originating post.

        try {
            array[BlogPostModelV3] result = apiInstance.getRelatedBlogPosts(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getRelatedBlogPosts");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the originating post.

        try {
            array[BlogPostModelV3] result = apiInstance.getRelatedBlogPosts(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getRelatedBlogPosts");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The ID of the originating post. (default to null)

// Get Related Blog Posts
[apiInstance getRelatedBlogPostsWith:id
              completionHandler: ^(array[BlogPostModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The ID of the originating post.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRelatedBlogPosts(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getRelatedBlogPostsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The ID of the originating post. (default to null)

            try {
                // Get Related Blog Posts
                array[BlogPostModelV3] result = apiInstance.getRelatedBlogPosts(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getRelatedBlogPosts: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The ID of the originating post.

try {
    $result = $api_instance->getRelatedBlogPosts($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getRelatedBlogPosts: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The ID of the originating post.

eval {
    my $result = $api_instance->getRelatedBlogPosts(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getRelatedBlogPosts: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The ID of the originating post. (default to null)

try:
    # Get Related Blog Posts
    api_response = api_instance.get_related_blog_posts(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getRelatedBlogPosts: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentV3Api::Context::default();
    let result = client.getRelatedBlogPosts(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the originating post.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getVideoContent

Get Video Content

Retrieve more information on a video attachment from a blog post in order to consume the video content.


/api/v3/content/video

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/content/video?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the video attachment object, from the `BlogPostModelV3`.

        try {
            ContentVideoV3Response result = apiInstance.getVideoContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getVideoContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        String id = id_example; // String | The ID of the video attachment object, from the `BlogPostModelV3`.

        try {
            ContentVideoV3Response result = apiInstance.getVideoContent(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#getVideoContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
String *id = id_example; // The ID of the video attachment object, from the `BlogPostModelV3`. (default to null)

// Get Video Content
[apiInstance getVideoContentWith:id
              completionHandler: ^(ContentVideoV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var id = id_example; // {String} The ID of the video attachment object, from the `BlogPostModelV3`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getVideoContent(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getVideoContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var id = id_example;  // String | The ID of the video attachment object, from the `BlogPostModelV3`. (default to null)

            try {
                // Get Video Content
                ContentVideoV3Response result = apiInstance.getVideoContent(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.getVideoContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$id = id_example; // String | The ID of the video attachment object, from the `BlogPostModelV3`.

try {
    $result = $api_instance->getVideoContent($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->getVideoContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $id = id_example; # String | The ID of the video attachment object, from the `BlogPostModelV3`.

eval {
    my $result = $api_instance->getVideoContent(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->getVideoContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
id = id_example # String | The ID of the video attachment object, from the `BlogPostModelV3`. (default to null)

try:
    # Get Video Content
    api_response = api_instance.get_video_content(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->getVideoContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = ContentV3Api::Context::default();
    let result = client.getVideoContent(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The ID of the video attachment object, from the `BlogPostModelV3`.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


likeContent

Like Content

Toggles the like status on a piece of content. If disliked before, it will turn into a like. If liked before, the like will be removed.


/api/v3/content/like

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/content/like" \
 -d '{
  "id" : "id",
  "contentType" : "blogPost"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        ContentLikeV3Request contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

        try {
            array['String'] result = apiInstance.likeContent(contentLikeV3Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#likeContent");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        ContentLikeV3Request contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

        try {
            array['String'] result = apiInstance.likeContent(contentLikeV3Request);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#likeContent");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
ContentLikeV3Request *contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // 

// Like Content
[apiInstance likeContentWith:contentLikeV3Request
              completionHandler: ^(array['String'] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // {ContentLikeV3Request} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.likeContent(contentLikeV3Request, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class likeContentExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var contentLikeV3Request = new ContentLikeV3Request(); // ContentLikeV3Request | 

            try {
                // Like Content
                array['String'] result = apiInstance.likeContent(contentLikeV3Request);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.likeContent: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request | 

try {
    $result = $api_instance->likeContent($contentLikeV3Request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->likeContent: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $contentLikeV3Request = WWW::OPenAPIClient::Object::ContentLikeV3Request->new(); # ContentLikeV3Request | 

eval {
    my $result = $api_instance->likeContent(contentLikeV3Request => $contentLikeV3Request);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->likeContent: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"} # ContentLikeV3Request | 

try:
    # Like Content
    api_response = api_instance.like_content(contentLikeV3Request)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->likeContent: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let contentLikeV3Request = {"contentType":"blogPost","id":"T2gWkpaerq"}; // ContentLikeV3Request

    let mut context = ContentV3Api::Context::default();
    let result = client.likeContent(contentLikeV3Request, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
contentLikeV3Request *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateProgress

Update Progress

Update the watch progress on a piece of media (usually video or audio), stored as the number of seconds in the media.


/api/v3/content/progress

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: text/plain,application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/content/progress" \
 -d '{
  "progress" : 0,
  "id" : "id",
  "contentType" : "video"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ContentV3Api;

import java.io.File;
import java.util.*;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        ContentV3Api apiInstance = new ContentV3Api();
        UpdateProgressRequest updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // UpdateProgressRequest | 

        try {
            'String' result = apiInstance.updateProgress(updateProgressRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#updateProgress");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ContentV3Api;

public class ContentV3ApiExample {
    public static void main(String[] args) {
        ContentV3Api apiInstance = new ContentV3Api();
        UpdateProgressRequest updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // UpdateProgressRequest | 

        try {
            'String' result = apiInstance.updateProgress(updateProgressRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContentV3Api#updateProgress");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
ContentV3Api *apiInstance = [[ContentV3Api alloc] init];
UpdateProgressRequest *updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // 

// Update Progress
[apiInstance updateProgressWith:updateProgressRequest
              completionHandler: ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.ContentV3Api()
var updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // {UpdateProgressRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateProgress(updateProgressRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateProgressExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new ContentV3Api();
            var updateProgressRequest = new UpdateProgressRequest(); // UpdateProgressRequest | 

            try {
                // Update Progress
                'String' result = apiInstance.updateProgress(updateProgressRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ContentV3Api.updateProgress: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentV3Api();
$updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // UpdateProgressRequest | 

try {
    $result = $api_instance->updateProgress($updateProgressRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentV3Api->updateProgress: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ContentV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ContentV3Api->new();
my $updateProgressRequest = WWW::OPenAPIClient::Object::UpdateProgressRequest->new(); # UpdateProgressRequest | 

eval {
    my $result = $api_instance->updateProgress(updateProgressRequest => $updateProgressRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ContentV3Api->updateProgress: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.ContentV3Api()
updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"} # UpdateProgressRequest | 

try:
    # Update Progress
    api_response = api_instance.update_progress(updateProgressRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ContentV3Api->updateProgress: %s\n" % e)
extern crate ContentV3Api;

pub fn main() {
    let updateProgressRequest = {"ids":["mhhrOfndeF","3qZrz5ugsa"],"contentType":"blogPost"}; // UpdateProgressRequest

    let mut context = ContentV3Api::Context::default();
    let result = client.updateProgress(updateProgressRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
updateProgressRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorSubscriptionPlanV2

getCreatorSubInfoPublic

Get Creator Sub Info Public

Retrieve detailed information about a creator's subscription plans and their subscriber count.


/api/v2/plan/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/plan/info?creatorId=creatorId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

import java.io.File;
import java.util.*;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();
        String creatorId = creatorId_example; // String | The GUID for the creator being search.

        try {
            PlanInfoV2Response result = apiInstance.getCreatorSubInfoPublic(creatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#getCreatorSubInfoPublic");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorSubscriptionPlanV2Api;

public class CreatorSubscriptionPlanV2ApiExample {
    public static void main(String[] args) {
        CreatorSubscriptionPlanV2Api apiInstance = new CreatorSubscriptionPlanV2Api();
        String creatorId = creatorId_example; // String | The GUID for the creator being search.

        try {
            PlanInfoV2Response result = apiInstance.getCreatorSubInfoPublic(creatorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorSubscriptionPlanV2Api#getCreatorSubInfoPublic");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorSubscriptionPlanV2Api *apiInstance = [[CreatorSubscriptionPlanV2Api alloc] init];
String *creatorId = creatorId_example; // The GUID for the creator being search. (default to null)

// Get Creator Sub Info Public
[apiInstance getCreatorSubInfoPublicWith:creatorId
              completionHandler: ^(PlanInfoV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorSubscriptionPlanV2Api()
var creatorId = creatorId_example; // {String} The GUID for the creator being search.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorSubInfoPublic(creatorId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorSubInfoPublicExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CreatorSubscriptionPlanV2Api();
            var creatorId = creatorId_example;  // String | The GUID for the creator being search. (default to null)

            try {
                // Get Creator Sub Info Public
                PlanInfoV2Response result = apiInstance.getCreatorSubInfoPublic(creatorId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorSubscriptionPlanV2Api.getCreatorSubInfoPublic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorSubscriptionPlanV2Api();
$creatorId = creatorId_example; // String | The GUID for the creator being search.

try {
    $result = $api_instance->getCreatorSubInfoPublic($creatorId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorSubscriptionPlanV2Api->getCreatorSubInfoPublic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorSubscriptionPlanV2Api->new();
my $creatorId = creatorId_example; # String | The GUID for the creator being search.

eval {
    my $result = $api_instance->getCreatorSubInfoPublic(creatorId => $creatorId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorSubscriptionPlanV2Api->getCreatorSubInfoPublic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorSubscriptionPlanV2Api()
creatorId = creatorId_example # String | The GUID for the creator being search. (default to null)

try:
    # Get Creator Sub Info Public
    api_response = api_instance.get_creator_sub_info_public(creatorId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorSubscriptionPlanV2Api->getCreatorSubInfoPublic: %s\n" % e)
extern crate CreatorSubscriptionPlanV2Api;

pub fn main() {
    let creatorId = creatorId_example; // String

    let mut context = CreatorSubscriptionPlanV2Api::Context::default();
    let result = client.getCreatorSubInfoPublic(creatorId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorId*
String
The GUID for the creator being search.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorV2

getCreatorInfoByName

Get Info By Name

Retrieve detailed information on one or more creators on Floatplane.


/api/v2/creator/named

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/named?creatorURL="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();
        array[String] creatorURL = ; // array[String] | The string identifer(s) of the creator(s) to be retrieved.

        try {
            array[CreatorModelV2Extended] result = apiInstance.getCreatorInfoByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getCreatorInfoByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();
        array[String] creatorURL = ; // array[String] | The string identifer(s) of the creator(s) to be retrieved.

        try {
            array[CreatorModelV2Extended] result = apiInstance.getCreatorInfoByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getCreatorInfoByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];
array[String] *creatorURL = ; // The string identifer(s) of the creator(s) to be retrieved. (default to null)

// Get Info By Name
[apiInstance getCreatorInfoByNameWith:creatorURL
              completionHandler: ^(array[CreatorModelV2Extended] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var creatorURL = ; // {array[String]} The string identifer(s) of the creator(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorInfoByName(creatorURL, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorInfoByNameExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();
            var creatorURL = new array[String](); // array[String] | The string identifer(s) of the creator(s) to be retrieved. (default to null)

            try {
                // Get Info By Name
                array[CreatorModelV2Extended] result = apiInstance.getCreatorInfoByName(creatorURL);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.getCreatorInfoByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();
$creatorURL = ; // array[String] | The string identifer(s) of the creator(s) to be retrieved.

try {
    $result = $api_instance->getCreatorInfoByName($creatorURL);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->getCreatorInfoByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();
my $creatorURL = []; # array[String] | The string identifer(s) of the creator(s) to be retrieved.

eval {
    my $result = $api_instance->getCreatorInfoByName(creatorURL => $creatorURL);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->getCreatorInfoByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()
creatorURL =  # array[String] | The string identifer(s) of the creator(s) to be retrieved. (default to null)

try:
    # Get Info By Name
    api_response = api_instance.get_creator_info_by_name(creatorURL)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->getCreatorInfoByName: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {
    let creatorURL = ; // array[String]

    let mut context = CreatorV2Api::Context::default();
    let result = client.getCreatorInfoByName(creatorURL, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorURL*
array[String]
The string identifer(s) of the creator(s) to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getInfo

Get Info

Retrieve detailed information on one or more creators on Floatplane.


/api/v2/creator/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/creator/info?creatorGUID="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV2Api;

import java.io.File;
import java.util.*;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV2Api apiInstance = new CreatorV2Api();
        array[String] creatorGUID = ; // array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

        try {
            array[CreatorModelV2] result = apiInstance.getInfo(creatorGUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV2Api;

public class CreatorV2ApiExample {
    public static void main(String[] args) {
        CreatorV2Api apiInstance = new CreatorV2Api();
        array[String] creatorGUID = ; // array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

        try {
            array[CreatorModelV2] result = apiInstance.getInfo(creatorGUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV2Api#getInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorV2Api *apiInstance = [[CreatorV2Api alloc] init];
array[String] *creatorGUID = ; // The GUID identifer(s) of the creator(s) to be retrieved. (default to null)

// Get Info
[apiInstance getInfoWith:creatorGUID
              completionHandler: ^(array[CreatorModelV2] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV2Api()
var creatorGUID = ; // {array[String]} The GUID identifer(s) of the creator(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getInfo(creatorGUID, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CreatorV2Api();
            var creatorGUID = new array[String](); // array[String] | The GUID identifer(s) of the creator(s) to be retrieved. (default to null)

            try {
                // Get Info
                array[CreatorModelV2] result = apiInstance.getInfo(creatorGUID);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV2Api.getInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV2Api();
$creatorGUID = ; // array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

try {
    $result = $api_instance->getInfo($creatorGUID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV2Api->getInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV2Api->new();
my $creatorGUID = []; # array[String] | The GUID identifer(s) of the creator(s) to be retrieved.

eval {
    my $result = $api_instance->getInfo(creatorGUID => $creatorGUID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV2Api->getInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV2Api()
creatorGUID =  # array[String] | The GUID identifer(s) of the creator(s) to be retrieved. (default to null)

try:
    # Get Info
    api_response = api_instance.get_info(creatorGUID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV2Api->getInfo: %s\n" % e)
extern crate CreatorV2Api;

pub fn main() {
    let creatorGUID = ; // array[String]

    let mut context = CreatorV2Api::Context::default();
    let result = client.getInfo(creatorGUID, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorGUID*
array[String]
The GUID identifer(s) of the creator(s) to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


CreatorV3

getCreator

Get Creator

Retrieve detailed information about a specific creator.


/api/v3/creator/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/info?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();
        String id = id_example; // String | The GUID of the creator being searched.

        try {
            CreatorModelV3 result = apiInstance.getCreator(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreator");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();
        String id = id_example; // String | The GUID of the creator being searched.

        try {
            CreatorModelV3 result = apiInstance.getCreator(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreator");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];
String *id = id_example; // The GUID of the creator being searched. (default to null)

// Get Creator
[apiInstance getCreatorWith:id
              completionHandler: ^(CreatorModelV3 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var id = id_example; // {String} The GUID of the creator being searched.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreator(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();
            var id = id_example;  // String | The GUID of the creator being searched. (default to null)

            try {
                // Get Creator
                CreatorModelV3 result = apiInstance.getCreator(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.getCreator: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();
$id = id_example; // String | The GUID of the creator being searched.

try {
    $result = $api_instance->getCreator($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->getCreator: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();
my $id = id_example; # String | The GUID of the creator being searched.

eval {
    my $result = $api_instance->getCreator(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->getCreator: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()
id = id_example # String | The GUID of the creator being searched. (default to null)

try:
    # Get Creator
    api_response = api_instance.get_creator(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->getCreator: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = CreatorV3Api::Context::default();
    let result = client.getCreator(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the creator being searched.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreatorByName

Get Creator By Name

Retrieve detailed information on one or more creators on Floatplane.


/api/v3/creator/named

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/named?creatorURL="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();
        array[String] creatorURL = ; // array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

        try {
            array[CreatorModelV3] result = apiInstance.getCreatorByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreatorByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();
        array[String] creatorURL = ; // array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

        try {
            array[CreatorModelV3] result = apiInstance.getCreatorByName(creatorURL);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreatorByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];
array[String] *creatorURL = ; // The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`. (default to null)

// Get Creator By Name
[apiInstance getCreatorByNameWith:creatorURL
              completionHandler: ^(array[CreatorModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var creatorURL = ; // {array[String]} The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreatorByName(creatorURL, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorByNameExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();
            var creatorURL = new array[String](); // array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`. (default to null)

            try {
                // Get Creator By Name
                array[CreatorModelV3] result = apiInstance.getCreatorByName(creatorURL);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.getCreatorByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();
$creatorURL = ; // array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

try {
    $result = $api_instance->getCreatorByName($creatorURL);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->getCreatorByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();
my $creatorURL = []; # array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.

eval {
    my $result = $api_instance->getCreatorByName(creatorURL => $creatorURL);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->getCreatorByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()
creatorURL =  # array[String] | The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`. (default to null)

try:
    # Get Creator By Name
    api_response = api_instance.get_creator_by_name(creatorURL)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->getCreatorByName: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {
    let creatorURL = ; // array[String]

    let mut context = CreatorV3Api::Context::default();
    let result = client.getCreatorByName(creatorURL, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creatorURL*
array[String]
The `urlname`(s) of the creator(s) to be retrieved. See `CreatorModelV3`.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getCreators

Get Creators

Retrieve and search for all creators on Floatplane. Useful for creator discovery and filtering.


/api/v3/creator/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/list?search=search_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();
        String search = search_example; // String | Optional search string for finding particular creators on the platform.

        try {
            array[CreatorModelV3] result = apiInstance.getCreators(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreators");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();
        String search = search_example; // String | Optional search string for finding particular creators on the platform.

        try {
            array[CreatorModelV3] result = apiInstance.getCreators(search);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#getCreators");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];
String *search = search_example; // Optional search string for finding particular creators on the platform. (default to null)

// Get Creators
[apiInstance getCreatorsWith:search
              completionHandler: ^(array[CreatorModelV3] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var search = search_example; // {String} Optional search string for finding particular creators on the platform.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCreators(search, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getCreatorsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();
            var search = search_example;  // String | Optional search string for finding particular creators on the platform. (default to null)

            try {
                // Get Creators
                array[CreatorModelV3] result = apiInstance.getCreators(search);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.getCreators: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();
$search = search_example; // String | Optional search string for finding particular creators on the platform.

try {
    $result = $api_instance->getCreators($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->getCreators: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();
my $search = search_example; # String | Optional search string for finding particular creators on the platform.

eval {
    my $result = $api_instance->getCreators(search => $search);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->getCreators: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()
search = search_example # String | Optional search string for finding particular creators on the platform. (default to null)

try:
    # Get Creators
    api_response = api_instance.get_creators(search)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->getCreators: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {
    let search = search_example; // String

    let mut context = CreatorV3Api::Context::default();
    let result = client.getCreators(search, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
search*

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listCreatorChannelsV3

List Creator Channels

Retrieves a list of channels within the given creator(s).


/api/v3/creator/channels/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/creator/channels/list?ids="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CreatorV3Api;

import java.io.File;
import java.util.*;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        CreatorV3Api apiInstance = new CreatorV3Api();
        array[String] ids = ; // array[String] | The ids of the creator(s) from which to search for channels.

        try {
            array[ChannelModel] result = apiInstance.listCreatorChannelsV3(ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#listCreatorChannelsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.CreatorV3Api;

public class CreatorV3ApiExample {
    public static void main(String[] args) {
        CreatorV3Api apiInstance = new CreatorV3Api();
        array[String] ids = ; // array[String] | The ids of the creator(s) from which to search for channels.

        try {
            array[ChannelModel] result = apiInstance.listCreatorChannelsV3(ids);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CreatorV3Api#listCreatorChannelsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
CreatorV3Api *apiInstance = [[CreatorV3Api alloc] init];
array[String] *ids = ; // The ids of the creator(s) from which to search for channels. (default to null)

// List Creator Channels
[apiInstance listCreatorChannelsV3With:ids
              completionHandler: ^(array[ChannelModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.CreatorV3Api()
var ids = ; // {array[String]} The ids of the creator(s) from which to search for channels.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorChannelsV3(ids, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCreatorChannelsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new CreatorV3Api();
            var ids = new array[String](); // array[String] | The ids of the creator(s) from which to search for channels. (default to null)

            try {
                // List Creator Channels
                array[ChannelModel] result = apiInstance.listCreatorChannelsV3(ids);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling CreatorV3Api.listCreatorChannelsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\CreatorV3Api();
$ids = ; // array[String] | The ids of the creator(s) from which to search for channels.

try {
    $result = $api_instance->listCreatorChannelsV3($ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CreatorV3Api->listCreatorChannelsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::CreatorV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::CreatorV3Api->new();
my $ids = []; # array[String] | The ids of the creator(s) from which to search for channels.

eval {
    my $result = $api_instance->listCreatorChannelsV3(ids => $ids);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CreatorV3Api->listCreatorChannelsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.CreatorV3Api()
ids =  # array[String] | The ids of the creator(s) from which to search for channels. (default to null)

try:
    # List Creator Channels
    api_response = api_instance.list_creator_channels_v3(ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CreatorV3Api->listCreatorChannelsV3: %s\n" % e)
extern crate CreatorV3Api;

pub fn main() {
    let ids = ; // array[String]

    let mut context = CreatorV3Api::Context::default();
    let result = client.listCreatorChannelsV3(ids, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
ids*
array[String]
The ids of the creator(s) from which to search for channels.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


DeliveryV3

getDeliveryInfoV3

Get Delivery Info

Given an video/audio attachment or livestream identifier, retrieves the information necessary to play, download, or livestream the media at various quality levels.


/api/v3/delivery/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/delivery/info?scenario=scenario_example&entityId=entityId_example&outputKind=outputKind_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.DeliveryV3Api;

import java.io.File;
import java.util.*;

public class DeliveryV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        DeliveryV3Api apiInstance = new DeliveryV3Api();
        String scenario = scenario_example; // String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
        String entityId = entityId_example; // String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
        String outputKind = outputKind_example; // String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

        try {
            CdnDeliveryV3Response result = apiInstance.getDeliveryInfoV3(scenario, entityId, outputKind);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryV3Api#getDeliveryInfoV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.DeliveryV3Api;

public class DeliveryV3ApiExample {
    public static void main(String[] args) {
        DeliveryV3Api apiInstance = new DeliveryV3Api();
        String scenario = scenario_example; // String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
        String entityId = entityId_example; // String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
        String outputKind = outputKind_example; // String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

        try {
            CdnDeliveryV3Response result = apiInstance.getDeliveryInfoV3(scenario, entityId, outputKind);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeliveryV3Api#getDeliveryInfoV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
DeliveryV3Api *apiInstance = [[DeliveryV3Api alloc] init];
String *scenario = scenario_example; // Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content (default to null)
String *entityId = entityId_example; // The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object. (default to null)
String *outputKind = outputKind_example; // Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+. (optional) (default to null)

// Get Delivery Info
[apiInstance getDeliveryInfoV3With:scenario
    entityId:entityId
    outputKind:outputKind
              completionHandler: ^(CdnDeliveryV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.DeliveryV3Api()
var scenario = scenario_example; // {String} Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
var entityId = entityId_example; // {String} The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
var opts = {
  'outputKind': outputKind_example // {String} Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeliveryInfoV3(scenario, entityId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getDeliveryInfoV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new DeliveryV3Api();
            var scenario = scenario_example;  // String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content (default to null)
            var entityId = entityId_example;  // String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object. (default to null)
            var outputKind = outputKind_example;  // String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+. (optional)  (default to null)

            try {
                // Get Delivery Info
                CdnDeliveryV3Response result = apiInstance.getDeliveryInfoV3(scenario, entityId, outputKind);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DeliveryV3Api.getDeliveryInfoV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\DeliveryV3Api();
$scenario = scenario_example; // String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
$entityId = entityId_example; // String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
$outputKind = outputKind_example; // String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

try {
    $result = $api_instance->getDeliveryInfoV3($scenario, $entityId, $outputKind);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DeliveryV3Api->getDeliveryInfoV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::DeliveryV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::DeliveryV3Api->new();
my $scenario = scenario_example; # String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content
my $entityId = entityId_example; # String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
my $outputKind = outputKind_example; # String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

eval {
    my $result = $api_instance->getDeliveryInfoV3(scenario => $scenario, entityId => $entityId, outputKind => $outputKind);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeliveryV3Api->getDeliveryInfoV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.DeliveryV3Api()
scenario = scenario_example # String | Used to determine the scenario in which to consume the media.

- `onDemand` = stream a Video/Audio On Demand
- `download` = Download the content for the user to play later.
- `live` = Livestream the content (default to null)
entityId = entityId_example # String | The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object. (default to null)
outputKind = outputKind_example # String | Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+. (optional) (default to null)

try:
    # Get Delivery Info
    api_response = api_instance.get_delivery_info_v3(scenario, entityId, outputKind=outputKind)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeliveryV3Api->getDeliveryInfoV3: %s\n" % e)
extern crate DeliveryV3Api;

pub fn main() {
    let scenario = scenario_example; // String
    let entityId = entityId_example; // String
    let outputKind = outputKind_example; // String

    let mut context = DeliveryV3Api::Context::default();
    let result = client.getDeliveryInfoV3(scenario, entityId, outputKind, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
scenario*
String
Used to determine the scenario in which to consume the media. - `onDemand` = stream a Video/Audio On Demand - `download` = Download the content for the user to play later. - `live` = Livestream the content
Required
entityId*
String
The attachment or livestream identifier for the requested media. For video and audio, this would be from the `videoAttachments` or `audioAttachments` objects. For livestreams, this is the `liveStream.id` from the creator object.
Required
outputKind
String
Use `outputKind` to ensure the right vehicle is used for your client, e.g. `outputKind=hls.fmp4` is optimal for tvOS 10+.

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


EdgesV2

getEdges

Get Edges

Retrieve a list of edge servers from which to stream or download videos. This is deprecated, and using the CDN endpoint is recommended as a replacement.


/api/v2/edges

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/edges"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EdgesV2Api;

import java.io.File;
import java.util.*;

public class EdgesV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        EdgesV2Api apiInstance = new EdgesV2Api();

        try {
            EdgesModel result = apiInstance.getEdges();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesV2Api#getEdges");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EdgesV2Api;

public class EdgesV2ApiExample {
    public static void main(String[] args) {
        EdgesV2Api apiInstance = new EdgesV2Api();

        try {
            EdgesModel result = apiInstance.getEdges();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EdgesV2Api#getEdges");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
EdgesV2Api *apiInstance = [[EdgesV2Api alloc] init];

// Get Edges
[apiInstance getEdgesWithCompletionHandler: 
              ^(EdgesModel output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');

// Create an instance of the API class
var api = new FloatplaneRestApi.EdgesV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEdges(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getEdgesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new EdgesV2Api();

            try {
                // Get Edges
                EdgesModel result = apiInstance.getEdges();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EdgesV2Api.getEdges: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EdgesV2Api();

try {
    $result = $api_instance->getEdges();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EdgesV2Api->getEdges: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EdgesV2Api;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EdgesV2Api->new();

eval {
    my $result = $api_instance->getEdges();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EdgesV2Api->getEdges: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.EdgesV2Api()

try:
    # Get Edges
    api_response = api_instance.get_edges()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EdgesV2Api->getEdges: %s\n" % e)
extern crate EdgesV2Api;

pub fn main() {

    let mut context = EdgesV2Api::Context::default();
    let result = client.getEdges(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


FAQV2

getFaqSections

Get Faq Sections

Retrieve a list of FAQ sections to display to the user. Each section contains one or more FAQ items. This is normally accessible from https://www.floatplane.com/support. Note that the answers to the FAQs will contain HTML.


/api/v2/faq/list

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/faq/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FAQV2Api;

import java.io.File;
import java.util.*;

public class FAQV2ApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        FAQV2Api apiInstance = new FAQV2Api();

        try {
            array[FaqSectionModel] result = apiInstance.getFaqSections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FAQV2Api#getFaqSections");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.FAQV2Api;

public class FAQV2ApiExample {
    public static void main(String[] args) {
        FAQV2Api apiInstance = new FAQV2Api();

        try {
            array[FaqSectionModel] result = apiInstance.getFaqSections();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FAQV2Api#getFaqSections");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
FAQV2Api *apiInstance = [[FAQV2Api alloc] init];

// Get Faq Sections
[apiInstance getFaqSectionsWithCompletionHandler: 
              ^(array[FaqSectionModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');

// Create an instance of the API class
var api = new FloatplaneRestApi.FAQV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFaqSections(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getFaqSectionsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new FAQV2Api();

            try {
                // Get Faq Sections
                array[FaqSectionModel] result = apiInstance.getFaqSections();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling FAQV2Api.getFaqSections: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\FAQV2Api();

try {
    $result = $api_instance->getFaqSections();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FAQV2Api->getFaqSections: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::FAQV2Api;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::FAQV2Api->new();

eval {
    my $result = $api_instance->getFaqSections();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FAQV2Api->getFaqSections: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.FAQV2Api()

try:
    # Get Faq Sections
    api_response = api_instance.get_faq_sections()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling FAQV2Api->getFaqSections: %s\n" % e)
extern crate FAQV2Api;

pub fn main() {

    let mut context = FAQV2Api::Context::default();
    let result = client.getFaqSections(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


LoyaltyRewardsV3

listCreatorLoyaltyReward

List Creator Loyalty Reward

Retrieve a list of loyalty rewards for the user. The reason for why this is a POST and not a GET is unknown.


/api/v3/user/loyaltyreward/list

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/loyaltyreward/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.LoyaltyRewardsV3Api;

import java.io.File;
import java.util.*;

public class LoyaltyRewardsV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        LoyaltyRewardsV3Api apiInstance = new LoyaltyRewardsV3Api();

        try {
            array[Object] result = apiInstance.listCreatorLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsV3Api#listCreatorLoyaltyReward");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.LoyaltyRewardsV3Api;

public class LoyaltyRewardsV3ApiExample {
    public static void main(String[] args) {
        LoyaltyRewardsV3Api apiInstance = new LoyaltyRewardsV3Api();

        try {
            array[Object] result = apiInstance.listCreatorLoyaltyReward();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling LoyaltyRewardsV3Api#listCreatorLoyaltyReward");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
LoyaltyRewardsV3Api *apiInstance = [[LoyaltyRewardsV3Api alloc] init];

// List Creator Loyalty Reward
[apiInstance listCreatorLoyaltyRewardWithCompletionHandler: 
              ^(array[Object] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.LoyaltyRewardsV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listCreatorLoyaltyReward(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listCreatorLoyaltyRewardExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new LoyaltyRewardsV3Api();

            try {
                // List Creator Loyalty Reward
                array[Object] result = apiInstance.listCreatorLoyaltyReward();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling LoyaltyRewardsV3Api.listCreatorLoyaltyReward: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\LoyaltyRewardsV3Api();

try {
    $result = $api_instance->listCreatorLoyaltyReward();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LoyaltyRewardsV3Api->listCreatorLoyaltyReward: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::LoyaltyRewardsV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::LoyaltyRewardsV3Api->new();

eval {
    my $result = $api_instance->listCreatorLoyaltyReward();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoyaltyRewardsV3Api->listCreatorLoyaltyReward: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.LoyaltyRewardsV3Api()

try:
    # List Creator Loyalty Reward
    api_response = api_instance.list_creator_loyalty_reward()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling LoyaltyRewardsV3Api->listCreatorLoyaltyReward: %s\n" % e)
extern crate LoyaltyRewardsV3Api;

pub fn main() {

    let mut context = LoyaltyRewardsV3Api::Context::default();
    let result = client.listCreatorLoyaltyReward(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


PaymentsV2

listAddresses

List Addresses

Retrieve a list of billing addresses saved to the user's account, to be used in conjunction with a payment method when purchasing subscriptions to creators.


/api/v2/payment/address/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/address/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            array[PaymentAddressModel] result = apiInstance.listAddresses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listAddresses");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            array[PaymentAddressModel] result = apiInstance.listAddresses();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listAddresses");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// List Addresses
[apiInstance listAddressesWithCompletionHandler: 
              ^(array[PaymentAddressModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAddresses(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listAddressesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // List Addresses
                array[PaymentAddressModel] result = apiInstance.listAddresses();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.listAddresses: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->listAddresses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->listAddresses: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->listAddresses();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->listAddresses: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # List Addresses
    api_response = api_instance.list_addresses()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->listAddresses: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.listAddresses(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listInvoices

List Invoices

Retrieve a list of paid or unpaid subscription invoices for the user.


/api/v2/payment/invoice/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/invoice/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            PaymentInvoiceListV2Response result = apiInstance.listInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listInvoices");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            PaymentInvoiceListV2Response result = apiInstance.listInvoices();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listInvoices");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// List Invoices
[apiInstance listInvoicesWithCompletionHandler: 
              ^(PaymentInvoiceListV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listInvoices(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listInvoicesExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // List Invoices
                PaymentInvoiceListV2Response result = apiInstance.listInvoices();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.listInvoices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->listInvoices();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->listInvoices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->listInvoices();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->listInvoices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # List Invoices
    api_response = api_instance.list_invoices()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->listInvoices: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.listInvoices(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


listPaymentMethods

List Payment Methods

Retrieve a list of saved payment methods for the user's account. Payment methods are how the user can pay for their subscription to creators on the platform.


/api/v2/payment/method/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/payment/method/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PaymentsV2Api;

import java.io.File;
import java.util.*;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            array[PaymentMethodModel] result = apiInstance.listPaymentMethods();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listPaymentMethods");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PaymentsV2Api;

public class PaymentsV2ApiExample {
    public static void main(String[] args) {
        PaymentsV2Api apiInstance = new PaymentsV2Api();

        try {
            array[PaymentMethodModel] result = apiInstance.listPaymentMethods();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PaymentsV2Api#listPaymentMethods");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PaymentsV2Api *apiInstance = [[PaymentsV2Api alloc] init];

// List Payment Methods
[apiInstance listPaymentMethodsWithCompletionHandler: 
              ^(array[PaymentMethodModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PaymentsV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listPaymentMethods(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listPaymentMethodsExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PaymentsV2Api();

            try {
                // List Payment Methods
                array[PaymentMethodModel] result = apiInstance.listPaymentMethods();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PaymentsV2Api.listPaymentMethods: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PaymentsV2Api();

try {
    $result = $api_instance->listPaymentMethods();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PaymentsV2Api->listPaymentMethods: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PaymentsV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PaymentsV2Api->new();

eval {
    my $result = $api_instance->listPaymentMethods();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PaymentsV2Api->listPaymentMethods: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PaymentsV2Api()

try:
    # List Payment Methods
    api_response = api_instance.list_payment_methods()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PaymentsV2Api->listPaymentMethods: %s\n" % e)
extern crate PaymentsV2Api;

pub fn main() {

    let mut context = PaymentsV2Api::Context::default();
    let result = client.listPaymentMethods(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


PollV3

joinLiveRoom

Poll Join Live Room

Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/poll/live/joinroom

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/poll/live/joinroom"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.joinLiveRoom();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#joinLiveRoom");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.joinLiveRoom();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#joinLiveRoom");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];

// Poll Join Live Room
[apiInstance joinLiveRoomWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.joinLiveRoom(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class joinLiveRoomExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PollV3Api();

            try {
                // Poll Join Live Room
                oas_any_type_not_mapped result = apiInstance.joinLiveRoom();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.joinLiveRoom: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();

try {
    $result = $api_instance->joinLiveRoom();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->joinLiveRoom: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();

eval {
    my $result = $api_instance->joinLiveRoom();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->joinLiveRoom: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()

try:
    # Poll Join Live Room
    api_response = api_instance.join_live_room()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->joinLiveRoom: %s\n" % e)
extern crate PollV3Api;

pub fn main() {

    let mut context = PollV3Api::Context::default();
    let result = client.joinLiveRoom(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


leaveLiveRoom

Poll Leave Live Room

Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/poll/live/leaveLiveRoom

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/poll/live/leaveLiveRoom"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.leaveLiveRoom();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#leaveLiveRoom");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.leaveLiveRoom();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#leaveLiveRoom");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];

// Poll Leave Live Room
[apiInstance leaveLiveRoomWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.leaveLiveRoom(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class leaveLiveRoomExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PollV3Api();

            try {
                // Poll Leave Live Room
                oas_any_type_not_mapped result = apiInstance.leaveLiveRoom();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.leaveLiveRoom: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();

try {
    $result = $api_instance->leaveLiveRoom();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->leaveLiveRoom: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();

eval {
    my $result = $api_instance->leaveLiveRoom();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->leaveLiveRoom: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()

try:
    # Poll Leave Live Room
    api_response = api_instance.leave_live_room()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->leaveLiveRoom: %s\n" % e)
extern crate PollV3Api;

pub fn main() {

    let mut context = PollV3Api::Context::default();
    let result = client.leaveLiveRoom(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


votePoll

Vote Poll

Vote on an option of a poll. Voting a second time or attempting to change a choice may result in an error.


/api/v3/poll/votePoll

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/poll/votePoll" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.PollV3Api;

import java.io.File;
import java.util.*;

public class PollV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        PollV3Api apiInstance = new PollV3Api();
        VotePollRequest votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // VotePollRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.votePoll(votePollRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#votePoll");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.PollV3Api;

public class PollV3ApiExample {
    public static void main(String[] args) {
        PollV3Api apiInstance = new PollV3Api();
        VotePollRequest votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // VotePollRequest | 

        try {
            oas_any_type_not_mapped result = apiInstance.votePoll(votePollRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PollV3Api#votePoll");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
PollV3Api *apiInstance = [[PollV3Api alloc] init];
VotePollRequest *votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // 

// Vote Poll
[apiInstance votePollWith:votePollRequest
              completionHandler: ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.PollV3Api()
var votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // {VotePollRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.votePoll(votePollRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class votePollExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new PollV3Api();
            var votePollRequest = new VotePollRequest(); // VotePollRequest | 

            try {
                // Vote Poll
                oas_any_type_not_mapped result = apiInstance.votePoll(votePollRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling PollV3Api.votePoll: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\PollV3Api();
$votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // VotePollRequest | 

try {
    $result = $api_instance->votePoll($votePollRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PollV3Api->votePoll: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::PollV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::PollV3Api->new();
my $votePollRequest = WWW::OPenAPIClient::Object::VotePollRequest->new(); # VotePollRequest | 

eval {
    my $result = $api_instance->votePoll(votePollRequest => $votePollRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling PollV3Api->votePoll: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.PollV3Api()
votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1} # VotePollRequest | 

try:
    # Vote Poll
    api_response = api_instance.vote_poll(votePollRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling PollV3Api->votePoll: %s\n" % e)
extern crate PollV3Api;

pub fn main() {
    let votePollRequest = {"pollId":"62c8c1dd968bc0899bbb4b92","optionIndex":1}; // VotePollRequest

    let mut context = PollV3Api::Context::default();
    let result = client.votePoll(votePollRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
votePollRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


RedirectV3

redirectYTLatest

Redirect to YouTube Latest Video

Redirects (HTTP 302) the user to the latest LMG video for a given LMG channel key. For example, visiting this URL with a `channelKey` of `sc`, it will take you directly to the latest Short Circuit video on YouTube. Unknown if this works for non-LMG creators for their channels. Not used in Floatplane code.


/api/v3/redirect-yt-latest/{channelKey}

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/redirect-yt-latest/{channelKey}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.RedirectV3Api;

import java.io.File;
import java.util.*;

public class RedirectV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        RedirectV3Api apiInstance = new RedirectV3Api();
        String channelKey = channelKey_example; // String | 

        try {
            ErrorModel result = apiInstance.redirectYTLatest(channelKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectV3Api#redirectYTLatest");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.RedirectV3Api;

public class RedirectV3ApiExample {
    public static void main(String[] args) {
        RedirectV3Api apiInstance = new RedirectV3Api();
        String channelKey = channelKey_example; // String | 

        try {
            ErrorModel result = apiInstance.redirectYTLatest(channelKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RedirectV3Api#redirectYTLatest");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
RedirectV3Api *apiInstance = [[RedirectV3Api alloc] init];
String *channelKey = channelKey_example; //  (default to null)

// Redirect to YouTube Latest Video
[apiInstance redirectYTLatestWith:channelKey
              completionHandler: ^(ErrorModel output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.RedirectV3Api()
var channelKey = channelKey_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.redirectYTLatest(channelKey, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class redirectYTLatestExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new RedirectV3Api();
            var channelKey = channelKey_example;  // String |  (default to null)

            try {
                // Redirect to YouTube Latest Video
                ErrorModel result = apiInstance.redirectYTLatest(channelKey);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling RedirectV3Api.redirectYTLatest: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\RedirectV3Api();
$channelKey = channelKey_example; // String | 

try {
    $result = $api_instance->redirectYTLatest($channelKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RedirectV3Api->redirectYTLatest: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::RedirectV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::RedirectV3Api->new();
my $channelKey = channelKey_example; # String | 

eval {
    my $result = $api_instance->redirectYTLatest(channelKey => $channelKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling RedirectV3Api->redirectYTLatest: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.RedirectV3Api()
channelKey = channelKey_example # String |  (default to null)

try:
    # Redirect to YouTube Latest Video
    api_response = api_instance.redirect_yt_latest(channelKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RedirectV3Api->redirectYTLatest: %s\n" % e)
extern crate RedirectV3Api;

pub fn main() {
    let channelKey = channelKey_example; // String

    let mut context = RedirectV3Api::Context::default();
    let result = client.redirectYTLatest(channelKey, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
channelKey*
String
Required

Responses

Name Type Format Description
Location String A YouTube URL for a video.

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


SocketV3

disconnectSocket

Disconnect

Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/socket/disconnect

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/socket/disconnect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketV3Api;

import java.io.File;
import java.util.*;

public class SocketV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SocketV3Api apiInstance = new SocketV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSocket();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV3Api#disconnectSocket");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketV3Api;

public class SocketV3ApiExample {
    public static void main(String[] args) {
        SocketV3Api apiInstance = new SocketV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.disconnectSocket();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV3Api#disconnectSocket");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SocketV3Api *apiInstance = [[SocketV3Api alloc] init];

// Disconnect
[apiInstance disconnectSocketWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SocketV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.disconnectSocket(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class disconnectSocketExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new SocketV3Api();

            try {
                // Disconnect
                oas_any_type_not_mapped result = apiInstance.disconnectSocket();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketV3Api.disconnectSocket: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketV3Api();

try {
    $result = $api_instance->disconnectSocket();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketV3Api->disconnectSocket: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketV3Api->new();

eval {
    my $result = $api_instance->disconnectSocket();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketV3Api->disconnectSocket: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketV3Api()

try:
    # Disconnect
    api_response = api_instance.disconnect_socket()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketV3Api->disconnectSocket: %s\n" % e)
extern crate SocketV3Api;

pub fn main() {

    let mut context = SocketV3Api::Context::default();
    let result = client.disconnectSocket(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


socketConnect

Connect

Used in Socket.IO/WebSocket connections. See the AsyncAPI documentation for more information. This should not be used on a raw HTTP connection.


/api/v3/socket/connect

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/socket/connect"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SocketV3Api;

import java.io.File;
import java.util.*;

public class SocketV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SocketV3Api apiInstance = new SocketV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.socketConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV3Api#socketConnect");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SocketV3Api;

public class SocketV3ApiExample {
    public static void main(String[] args) {
        SocketV3Api apiInstance = new SocketV3Api();

        try {
            oas_any_type_not_mapped result = apiInstance.socketConnect();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SocketV3Api#socketConnect");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SocketV3Api *apiInstance = [[SocketV3Api alloc] init];

// Connect
[apiInstance socketConnectWithCompletionHandler: 
              ^(oas_any_type_not_mapped output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SocketV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.socketConnect(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class socketConnectExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new SocketV3Api();

            try {
                // Connect
                oas_any_type_not_mapped result = apiInstance.socketConnect();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SocketV3Api.socketConnect: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SocketV3Api();

try {
    $result = $api_instance->socketConnect();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SocketV3Api->socketConnect: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SocketV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SocketV3Api->new();

eval {
    my $result = $api_instance->socketConnect();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SocketV3Api->socketConnect: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SocketV3Api()

try:
    # Connect
    api_response = api_instance.socket_connect()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SocketV3Api->socketConnect: %s\n" % e)
extern crate SocketV3Api;

pub fn main() {

    let mut context = SocketV3Api::Context::default();
    let result = client.socketConnect(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


SubscriptionsV3

listUserSubscriptionsV3

List User Subscriptions

Retrieve a list of all active subscriptions for the user.


/api/v3/user/subscriptions

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/subscriptions"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.SubscriptionsV3Api;

import java.io.File;
import java.util.*;

public class SubscriptionsV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        SubscriptionsV3Api apiInstance = new SubscriptionsV3Api();

        try {
            array[UserSubscriptionModel] result = apiInstance.listUserSubscriptionsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV3Api#listUserSubscriptionsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.SubscriptionsV3Api;

public class SubscriptionsV3ApiExample {
    public static void main(String[] args) {
        SubscriptionsV3Api apiInstance = new SubscriptionsV3Api();

        try {
            array[UserSubscriptionModel] result = apiInstance.listUserSubscriptionsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SubscriptionsV3Api#listUserSubscriptionsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
SubscriptionsV3Api *apiInstance = [[SubscriptionsV3Api alloc] init];

// List User Subscriptions
[apiInstance listUserSubscriptionsV3WithCompletionHandler: 
              ^(array[UserSubscriptionModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.SubscriptionsV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listUserSubscriptionsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listUserSubscriptionsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new SubscriptionsV3Api();

            try {
                // List User Subscriptions
                array[UserSubscriptionModel] result = apiInstance.listUserSubscriptionsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling SubscriptionsV3Api.listUserSubscriptionsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\SubscriptionsV3Api();

try {
    $result = $api_instance->listUserSubscriptionsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SubscriptionsV3Api->listUserSubscriptionsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::SubscriptionsV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::SubscriptionsV3Api->new();

eval {
    my $result = $api_instance->listUserSubscriptionsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SubscriptionsV3Api->listUserSubscriptionsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.SubscriptionsV3Api()

try:
    # List User Subscriptions
    api_response = api_instance.list_user_subscriptions_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SubscriptionsV3Api->listUserSubscriptionsV3: %s\n" % e)
extern crate SubscriptionsV3Api;

pub fn main() {

    let mut context = SubscriptionsV3Api::Context::default();
    let result = client.listUserSubscriptionsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


UserV2

getSecurity

Get Security

Retrieve information about the current security configuration for the user.


/api/v2/user/security

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/security"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();

        try {
            UserSecurityV2Response result = apiInstance.getSecurity();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getSecurity");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();

        try {
            UserSecurityV2Response result = apiInstance.getSecurity();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getSecurity");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];

// Get Security
[apiInstance getSecurityWithCompletionHandler: 
              ^(UserSecurityV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSecurity(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSecurityExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserV2Api();

            try {
                // Get Security
                UserSecurityV2Response result = apiInstance.getSecurity();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getSecurity: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();

try {
    $result = $api_instance->getSecurity();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getSecurity: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();

eval {
    my $result = $api_instance->getSecurity();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getSecurity: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()

try:
    # Get Security
    api_response = api_instance.get_security()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getSecurity: %s\n" % e)
extern crate UserV2Api;

pub fn main() {

    let mut context = UserV2Api::Context::default();
    let result = client.getSecurity(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserInfo

Info

Retrieve more detailed information about one or more users from their identifiers.


/api/v2/user/info

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/info?id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();
        array[String] id = ; // array[String] | The GUID identifer(s) of the user(s) to be retrieved.

        try {
            UserInfoV2Response result = apiInstance.getUserInfo(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserInfo");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();
        array[String] id = ; // array[String] | The GUID identifer(s) of the user(s) to be retrieved.

        try {
            UserInfoV2Response result = apiInstance.getUserInfo(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserInfo");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];
array[String] *id = ; // The GUID identifer(s) of the user(s) to be retrieved. (default to null)

// Info
[apiInstance getUserInfoWith:id
              completionHandler: ^(UserInfoV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var id = ; // {array[String]} The GUID identifer(s) of the user(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserInfo(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserInfoExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserV2Api();
            var id = new array[String](); // array[String] | The GUID identifer(s) of the user(s) to be retrieved. (default to null)

            try {
                // Info
                UserInfoV2Response result = apiInstance.getUserInfo(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getUserInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();
$id = ; // array[String] | The GUID identifer(s) of the user(s) to be retrieved.

try {
    $result = $api_instance->getUserInfo($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getUserInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();
my $id = []; # array[String] | The GUID identifer(s) of the user(s) to be retrieved.

eval {
    my $result = $api_instance->getUserInfo(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getUserInfo: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()
id =  # array[String] | The GUID identifer(s) of the user(s) to be retrieved. (default to null)

try:
    # Info
    api_response = api_instance.get_user_info(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getUserInfo: %s\n" % e)
extern crate UserV2Api;

pub fn main() {
    let id = ; // array[String]

    let mut context = UserV2Api::Context::default();
    let result = client.getUserInfo(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
array[String]
The GUID identifer(s) of the user(s) to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserInfoByName

Get Info By Name

Retrieve more detailed information about one or more users from their usernames.


/api/v2/user/named

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/named?username="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();
        array[String] username = ; // array[String] | The username(s) of the user(s) to be retrieved.

        try {
            UserNamedV2Response result = apiInstance.getUserInfoByName(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserInfoByName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();
        array[String] username = ; // array[String] | The username(s) of the user(s) to be retrieved.

        try {
            UserNamedV2Response result = apiInstance.getUserInfoByName(username);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#getUserInfoByName");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];
array[String] *username = ; // The username(s) of the user(s) to be retrieved. (default to null)

// Get Info By Name
[apiInstance getUserInfoByNameWith:username
              completionHandler: ^(UserNamedV2Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var username = ; // {array[String]} The username(s) of the user(s) to be retrieved.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserInfoByName(username, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserInfoByNameExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserV2Api();
            var username = new array[String](); // array[String] | The username(s) of the user(s) to be retrieved. (default to null)

            try {
                // Get Info By Name
                UserNamedV2Response result = apiInstance.getUserInfoByName(username);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.getUserInfoByName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();
$username = ; // array[String] | The username(s) of the user(s) to be retrieved.

try {
    $result = $api_instance->getUserInfoByName($username);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->getUserInfoByName: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();
my $username = []; # array[String] | The username(s) of the user(s) to be retrieved.

eval {
    my $result = $api_instance->getUserInfoByName(username => $username);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->getUserInfoByName: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()
username =  # array[String] | The username(s) of the user(s) to be retrieved. (default to null)

try:
    # Get Info By Name
    api_response = api_instance.get_user_info_by_name(username)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->getUserInfoByName: %s\n" % e)
extern crate UserV2Api;

pub fn main() {
    let username = ; // array[String]

    let mut context = UserV2Api::Context::default();
    let result = client.getUserInfoByName(username, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
username*
array[String]
The username(s) of the user(s) to be retrieved.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


userCreatorBanStatus

User Creator Ban Status

Determine whether or not the user is banned for a given creator.


/api/v2/user/ban/status

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v2/user/ban/status?creator=creator_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV2Api;

import java.io.File;
import java.util.*;

public class UserV2ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV2Api apiInstance = new UserV2Api();
        String creator = creator_example; // String | The GUID of the creator being queried.

        try {
            'Boolean' result = apiInstance.userCreatorBanStatus(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#userCreatorBanStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV2Api;

public class UserV2ApiExample {
    public static void main(String[] args) {
        UserV2Api apiInstance = new UserV2Api();
        String creator = creator_example; // String | The GUID of the creator being queried.

        try {
            'Boolean' result = apiInstance.userCreatorBanStatus(creator);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV2Api#userCreatorBanStatus");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserV2Api *apiInstance = [[UserV2Api alloc] init];
String *creator = creator_example; // The GUID of the creator being queried. (default to null)

// User Creator Ban Status
[apiInstance userCreatorBanStatusWith:creator
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV2Api()
var creator = creator_example; // {String} The GUID of the creator being queried.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.userCreatorBanStatus(creator, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class userCreatorBanStatusExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserV2Api();
            var creator = creator_example;  // String | The GUID of the creator being queried. (default to null)

            try {
                // User Creator Ban Status
                'Boolean' result = apiInstance.userCreatorBanStatus(creator);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV2Api.userCreatorBanStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV2Api();
$creator = creator_example; // String | The GUID of the creator being queried.

try {
    $result = $api_instance->userCreatorBanStatus($creator);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV2Api->userCreatorBanStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV2Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV2Api->new();
my $creator = creator_example; # String | The GUID of the creator being queried.

eval {
    my $result = $api_instance->userCreatorBanStatus(creator => $creator);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV2Api->userCreatorBanStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV2Api()
creator = creator_example # String | The GUID of the creator being queried. (default to null)

try:
    # User Creator Ban Status
    api_response = api_instance.user_creator_ban_status(creator)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV2Api->userCreatorBanStatus: %s\n" % e)
extern crate UserV2Api;

pub fn main() {
    let creator = creator_example; // String

    let mut context = UserV2Api::Context::default();
    let result = client.userCreatorBanStatus(creator, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
creator*
String
The GUID of the creator being queried.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


UserV3

getActivityFeedV3

Get Activity Feed

Retrieve recent activity for a user, such as comments and other interactions they have made on posts for creators.


/api/v3/user/activity

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/activity?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();
        String id = id_example; // String | The GUID of the user being queried.

        try {
            UserActivityV3Response result = apiInstance.getActivityFeedV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getActivityFeedV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();
        String id = id_example; // String | The GUID of the user being queried.

        try {
            UserActivityV3Response result = apiInstance.getActivityFeedV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getActivityFeedV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];
String *id = id_example; // The GUID of the user being queried. (default to null)

// Get Activity Feed
[apiInstance getActivityFeedV3With:id
              completionHandler: ^(UserActivityV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var id = id_example; // {String} The GUID of the user being queried.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActivityFeedV3(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getActivityFeedV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserV3Api();
            var id = id_example;  // String | The GUID of the user being queried. (default to null)

            try {
                // Get Activity Feed
                UserActivityV3Response result = apiInstance.getActivityFeedV3(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.getActivityFeedV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();
$id = id_example; // String | The GUID of the user being queried.

try {
    $result = $api_instance->getActivityFeedV3($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->getActivityFeedV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();
my $id = id_example; # String | The GUID of the user being queried.

eval {
    my $result = $api_instance->getActivityFeedV3(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->getActivityFeedV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()
id = id_example # String | The GUID of the user being queried. (default to null)

try:
    # Get Activity Feed
    api_response = api_instance.get_activity_feed_v3(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->getActivityFeedV3: %s\n" % e)
extern crate UserV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = UserV3Api::Context::default();
    let result = client.getActivityFeedV3(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the user being queried.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getExternalLinksV3

Get External Links

Retrieve configured social media links from a user's profile.


/api/v3/user/links

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/links?id=id_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();
        String id = id_example; // String | The GUID of the user being searched.

        try {
            map['String', UserLinksV3Response_value] result = apiInstance.getExternalLinksV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getExternalLinksV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();
        String id = id_example; // String | The GUID of the user being searched.

        try {
            map['String', UserLinksV3Response_value] result = apiInstance.getExternalLinksV3(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getExternalLinksV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];
String *id = id_example; // The GUID of the user being searched. (default to null)

// Get External Links
[apiInstance getExternalLinksV3With:id
              completionHandler: ^(map['String', UserLinksV3Response_value] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var id = id_example; // {String} The GUID of the user being searched.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExternalLinksV3(id, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getExternalLinksV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserV3Api();
            var id = id_example;  // String | The GUID of the user being searched. (default to null)

            try {
                // Get External Links
                map['String', UserLinksV3Response_value] result = apiInstance.getExternalLinksV3(id);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.getExternalLinksV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();
$id = id_example; // String | The GUID of the user being searched.

try {
    $result = $api_instance->getExternalLinksV3($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->getExternalLinksV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();
my $id = id_example; # String | The GUID of the user being searched.

eval {
    my $result = $api_instance->getExternalLinksV3(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->getExternalLinksV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()
id = id_example # String | The GUID of the user being searched. (default to null)

try:
    # Get External Links
    api_response = api_instance.get_external_links_v3(id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->getExternalLinksV3: %s\n" % e)
extern crate UserV3Api;

pub fn main() {
    let id = id_example; // String

    let mut context = UserV3Api::Context::default();
    let result = client.getExternalLinksV3(id, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Query parameters
Name Description
id*
String
The GUID of the user being searched.
Required

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getSelf

Get Self

Retrieve more detailed information about the user, including their name and email.


/api/v3/user/self

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/self"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();

        try {
            UserSelfV3Response result = apiInstance.getSelf();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getSelf");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();

        try {
            UserSelfV3Response result = apiInstance.getSelf();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getSelf");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];

// Get Self
[apiInstance getSelfWithCompletionHandler: 
              ^(UserSelfV3Response output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getSelf(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getSelfExample
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserV3Api();

            try {
                // Get Self
                UserSelfV3Response result = apiInstance.getSelf();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.getSelf: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();

try {
    $result = $api_instance->getSelf();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->getSelf: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();

eval {
    my $result = $api_instance->getSelf();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->getSelf: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()

try:
    # Get Self
    api_response = api_instance.get_self()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->getSelf: %s\n" % e)
extern crate UserV3Api;

pub fn main() {

    let mut context = UserV3Api::Context::default();
    let result = client.getSelf(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


getUserNotificationSettingsV3

Get User Notification Settings

Retrieve notification details for a user. The details are split into seperate settings for each subscribed creator.


/api/v3/user/notification/list

Usage and SDK Samples

curl -X GET \
 \
 -H "Accept: application/json,text/html" \
 "https://www.floatplane.com/api/v3/user/notification/list"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();

        try {
            array[UserNotificationModel] result = apiInstance.getUserNotificationSettingsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();

        try {
            array[UserNotificationModel] result = apiInstance.getUserNotificationSettingsV3();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#getUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];

// Get User Notification Settings
[apiInstance getUserNotificationSettingsV3WithCompletionHandler: 
              ^(array[UserNotificationModel] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUserNotificationSettingsV3(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getUserNotificationSettingsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserV3Api();

            try {
                // Get User Notification Settings
                array[UserNotificationModel] result = apiInstance.getUserNotificationSettingsV3();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.getUserNotificationSettingsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();

try {
    $result = $api_instance->getUserNotificationSettingsV3();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->getUserNotificationSettingsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();

eval {
    my $result = $api_instance->getUserNotificationSettingsV3();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->getUserNotificationSettingsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()

try:
    # Get User Notification Settings
    api_response = api_instance.get_user_notification_settings_v3()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->getUserNotificationSettingsV3: %s\n" % e)
extern crate UserV3Api;

pub fn main() {

    let mut context = UserV3Api::Context::default();
    let result = client.getUserNotificationSettingsV3(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.


updateUserNotificationSettingsV3

Update User Notification Settings

Enable or disable email or push notifications for a specific creator.


/api/v3/user/notification/update

Usage and SDK Samples

curl -X POST \
 \
 -H "Accept: application/json,text/html" \
 -H "Content-Type: application/json" \
 "https://www.floatplane.com/api/v3/user/notification/update" \
 -d '{
  "newValue" : true,
  "creator" : "creator",
  "property" : "contentEmail"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UserV3Api;

import java.io.File;
import java.util.*;

public class UserV3ApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: CookieAuth
        ApiKeyAuth CookieAuth = (ApiKeyAuth) defaultClient.getAuthentication("CookieAuth");
        CookieAuth.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //CookieAuth.setApiKeyPrefix("Token");

        // Create an instance of the API class
        UserV3Api apiInstance = new UserV3Api();
        UserNotificationUpdateV3PostRequest userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest | 

        try {
            'Boolean' result = apiInstance.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#updateUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.UserV3Api;

public class UserV3ApiExample {
    public static void main(String[] args) {
        UserV3Api apiInstance = new UserV3Api();
        UserNotificationUpdateV3PostRequest userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest | 

        try {
            'Boolean' result = apiInstance.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UserV3Api#updateUserNotificationSettingsV3");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: CookieAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"sails.sid"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"sails.sid"];


// Create an instance of the API class
UserV3Api *apiInstance = [[UserV3Api alloc] init];
UserNotificationUpdateV3PostRequest *userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // 

// Update User Notification Settings
[apiInstance updateUserNotificationSettingsV3With:userNotificationUpdateV3PostRequest
              completionHandler: ^('Boolean' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var FloatplaneRestApi = require('floatplane_rest_api');
var defaultClient = FloatplaneRestApi.ApiClient.instance;

// Configure API key authorization: CookieAuth
var CookieAuth = defaultClient.authentications['CookieAuth'];
CookieAuth.apiKey = "YOUR API KEY";
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//CookieAuth.apiKeyPrefix['sails.sid'] = "Token";

// Create an instance of the API class
var api = new FloatplaneRestApi.UserV3Api()
var userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // {UserNotificationUpdateV3PostRequest} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updateUserNotificationSettingsV3Example
    {
        public void main()
        {
            // Configure API key authorization: CookieAuth
            Configuration.Default.ApiKey.Add("sails.sid", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("sails.sid", "Bearer");

            // Create an instance of the API class
            var apiInstance = new UserV3Api();
            var userNotificationUpdateV3PostRequest = new UserNotificationUpdateV3PostRequest(); // UserNotificationUpdateV3PostRequest | 

            try {
                // Update User Notification Settings
                'Boolean' result = apiInstance.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling UserV3Api.updateUserNotificationSettingsV3: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: CookieAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('sails.sid', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('sails.sid', 'Bearer');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\UserV3Api();
$userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest | 

try {
    $result = $api_instance->updateUserNotificationSettingsV3($userNotificationUpdateV3PostRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserV3Api->updateUserNotificationSettingsV3: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::UserV3Api;

# Configure API key authorization: CookieAuth
$WWW::OPenAPIClient::Configuration::api_key->{'sails.sid'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::OPenAPIClient::Configuration::api_key_prefix->{'sails.sid'} = "Bearer";

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::UserV3Api->new();
my $userNotificationUpdateV3PostRequest = WWW::OPenAPIClient::Object::UserNotificationUpdateV3PostRequest->new(); # UserNotificationUpdateV3PostRequest | 

eval {
    my $result = $api_instance->updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest => $userNotificationUpdateV3PostRequest);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UserV3Api->updateUserNotificationSettingsV3: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: CookieAuth
openapi_client.configuration.api_key['sails.sid'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# openapi_client.configuration.api_key_prefix['sails.sid'] = 'Bearer'

# Create an instance of the API class
api_instance = openapi_client.UserV3Api()
userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false} # UserNotificationUpdateV3PostRequest | 

try:
    # Update User Notification Settings
    api_response = api_instance.update_user_notification_settings_v3(userNotificationUpdateV3PostRequest)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling UserV3Api->updateUserNotificationSettingsV3: %s\n" % e)
extern crate UserV3Api;

pub fn main() {
    let userNotificationUpdateV3PostRequest = {"creator":"59f94c0bdd241b70349eb72b","property":"contentFirebase","newValue":false}; // UserNotificationUpdateV3PostRequest

    let mut context = UserV3Api::Context::default();
    let result = client.updateUserNotificationSettingsV3(userNotificationUpdateV3PostRequest, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
userNotificationUpdateV3PostRequest *

Responses

Name Type Format Description
RetryMinusAfter Integer The number of seconds the client must wait until future requests will respond normally.