Mock sample for your project: PeerTube API

Integrate with "PeerTube API" from cpy.re in no time with Mockoon's ready to use mock sample

PeerTube

cpy.re

Version: 3.3.0


Use this API in your project

Speed up your application development by using "PeerTube API" ready-to-use mock sample. Mocking this API will allow you to start working in no time. No more accounts to create, API keys to provision, accesses to configure, unplanned downtime, just work.
It also improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.

Description

The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with
openapi-generator
which generates a client SDK in the language of your choice - we generate some client SDKs automatically:
Python
Go
Kotlin
See the REST API quick start for a few
examples of using the PeerTube API.
Authentication
When you sign up for an account on a PeerTube instance, you are given the possibility
to generate sessions on it, and authenticate there using an access token. Only __one
access token can currently be used at a time__.
Roles
Accounts are given permissions based on their role. There are three roles on
PeerTube: Administrator, Moderator, and User. See the roles guide for a detail of their permissions.
Errors
The API uses standard HTTP status codes to indicate the success or failure
of the API call, completed by a RFC7807-compliant response body.
Where id is the name of the field concerned by the error, within the route definition.
invalid-params..location can be either 'params', 'body', 'header', 'query' or 'cookies', and
invalid-params..value reports the value that didn't pass validation whose invalid-params..msg
is about.
Deprecated error fields
Some fields could be included with previous versions. They are still included but their use is deprecated:
error: superseded by detail
code: superseded by type (which is now an URI)
Rate limits
We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
| Endpoint (prefix: /api/v1) | Calls | Time frame |
|------------------------------|---------------|--------------|
| /* | 50 | 10 seconds |
| POST /users/token | 15 | 5 minutes |
| POST /users/register | 2 * | 5 minutes |
| POST /users/ask-send-verify-email | 3 | 5 minutes |
Depending on the endpoint, * failed requests are not taken into account. A service
limit is announced by a 429 Too Many Requests status code.
You can get details about the current state of your rate limit by reading the
following headers:
| Header | Description |
|-------------------------|------------------------------------------------------------|
| X-RateLimit-Limit | Number of max requests allowed in the current time period |
| X-RateLimit-Remaining | Number of remaining requests in the current time period |
| X-RateLimit-Reset | Timestamp of end of current time period as UNIX timestamp |
| Retry-After | Seconds to delay after the first 429 is received |
CORS
This API features Cross-Origin Resource Sharing (CORS),
allowing cross-domain communication from the browser for some routes:
| Endpoint |
|------------------------- ---|
| /api/* |
| /download/* |
| /lazy-static/* |
| /live/segments-sha256/* |
| /.well-known/webfinger |
In addition, all routes serving ActivityPub are CORS-enabled for all origins.

Other APIs in the same category

PeerTube

The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with
openapi-generator
which generates a client SDK in the language of your choice - we generate some client SDKs automatically:
Python
Go
Kotlin
See the REST API quick start for a few
examples of using the PeerTube API.
Authentication
When you sign up for an account on a PeerTube instance, you are given the possibility
to generate sessions on it, and authenticate there using an access token. Only __one
access token can currently be used at a time__.
Roles
Accounts are given permissions based on their role. There are three roles on
PeerTube: Administrator, Moderator, and User. See the roles guide for a detail of their permissions.
Errors
The API uses standard HTTP status codes to indicate the success or failure
of the API call, completed by a RFC7807-compliant response body.
Where id is the name of the field concerned by the error, within the route definition.
invalid-params..location can be either 'params', 'body', 'header', 'query' or 'cookies', and
invalid-params..value reports the value that didn't pass validation whose invalid-params..msg
is about.
Deprecated error fields
Some fields could be included with previous versions. They are still included but their use is deprecated:
error: superseded by detail
code: superseded by type (which is now an URI)
Rate limits
We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
| Endpoint (prefix: /api/v1) | Calls | Time frame |
|------------------------------|---------------|--------------|
| /* | 50 | 10 seconds |
| POST /users/token | 15 | 5 minutes |
| POST /users/register | 2 * | 5 minutes |
| POST /users/ask-send-verify-email | 3 | 5 minutes |
Depending on the endpoint, * failed requests are not taken into account. A service
limit is announced by a 429 Too Many Requests status code.
You can get details about the current state of your rate limit by reading the
following headers:
| Header | Description |
|-------------------------|------------------------------------------------------------|
| X-RateLimit-Limit | Number of max requests allowed in the current time period |
| X-RateLimit-Remaining | Number of remaining requests in the current time period |
| X-RateLimit-Reset | Timestamp of end of current time period as UNIX timestamp |
| Retry-After | Seconds to delay after the first 429 is received |
CORS
This API features Cross-Origin Resource Sharing (CORS),
allowing cross-domain communication from the browser for some routes:
| Endpoint |
|------------------------- ---|
| /api/* |
| /download/* |
| /lazy-static/* |
| /live/segments-sha256/* |
| /.well-known/webfinger |
In addition, all routes serving ActivityPub are CORS-enabled for all origins.

Bufferapp

Social media management for marketers and agencies

Tweets and Users

API Reference — Labs v2

Clubhouse API

clubhouseapi.com
Clubhouse API

Mastodon API

API for GNU Social-compatible microblogging server

Wedpax

wedpax.com

StatSocial Platform API

API Reference: The StatSocial API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients, and we support cross-origin resource sharing to allow you to interact securely with our API from a client-side web application (remember that you should never expose your secret API key in any public website's client-side code). JSON will be returned in all responses from the API, including errors (though if you're using API bindings, we will convert the response to the appropriate language-specific object). Contact [email protected] to obtain a test API key

Semantria

Semantria applies Text and Sentiment Analysis to tweets, facebook posts, surveys, reviews or enterprise content.

Contribly

contribly.com

RiteKit API

ritekit.com
RiteKit API is based on REST principles.
Authentication uses standard OAuth 2.0 process
##Getting started
Sign up for RiteKit
Go to developer dashboard
Click "Create a token" button to get your Client ID and Client secret
When you reach your free limit of calls per month, upgrade to paid tiers
Options for authorizing API Calls
Using Client ID directly
You can directly connect to our API using your client ID by sending it as a GET query parameter. This option is simple (no need for oAuth) but it should be used only in case the Client ID is not exposed publicly.
GET https://api.ritekit.com/v1/stats/multiple-hashtags?tags=php&client_id=292c6912e7710c838347ae178b4a

Discourse API Documentation

discourse.local
This page contains the documentation on how to use Discourse through API calls.
> Note: For any endpoints not listed you can follow the
reverse engineer the Discourse API
guide to figure out how to use an API endpoint.
Request Content-Type
The Content-Type for POST and PUT requests can be set to application/x-www-form-urlencoded,
multipart/form-data, or application/json.
Endpoint Names and Response Content-Type
Most API endpoints provide the same content as their HTML counterparts. For example
the URL /categories serves a list of categories, the /categories.json API provides the
same information in JSON format.
Instead of sending API requests to /categories.json you may also send them to /categories
and add an Accept: application/json header to the request to get the JSON response.
Sending requests with the Accept header is necessary if you want to use URLs
for related endpoints returned by the API, such as pagination URLs.
These URLs are returned without the .json prefix so you need to add the header in
order to get the correct response format.
Authentication
Some endpoints do not require any authentication, pretty much anything else will
require you to be authenticated.
To become authenticated you will need to create an API Key from the admin panel.
Once you have your API Key you can pass it in along with your API Username
as an HTTP header like this:
Boolean values
If an endpoint accepts a boolean be sure to specify it as a lowercase
true or false value unless noted otherwise.