beta/docs
OverviewGuides
Log inSign up
OverviewGuides
Sign upLogin

API Reference

Livepeer.com API Reference
Version: 0.0.1-alpha.0
/object-store
/api-token
/webhook

Livepeer.com API Reference

Version: 0.0.1-alpha.0

#/stream

#POST

#Description

Receives Wowza stream

#Responses
Code Description
200 Success
default Error

#GET

#Description

Lists streams

#Responses
Code Description
200 Success
default Error

#/object-store

#POST

#Description

Receives store credentials

#Responses
Code Description
200 Success
default Error

#GET

#Description

Lists object store credentials by userId

#Responses
Code Description
200 Success
default Error

#/user-verification

#POST

#Description

Verifies user email

#Responses
Code Description
200 Success
default Error

#/password-reset-token

#POST

#Description

Creates a password reset token

#Responses
Code Description
200 Success
default Error

#/password-reset

#POST

#Description

Verifies password reset token

#Responses
Code Description
200 Success
default Error

#/make-admin

#POST

#Description

Changes user admin status

#Responses
Code Description
200 Success
default Error

#/user/token

#POST

#Description

Receives user login information

#Responses
Code Description
200 Success
default Error

#/user

#POST

#Description

Receives user information

#Responses
Code Description
200 Success
default Error

#PATCH

#Description

updates a user

#Parameters
Name Located in Description Required Schema
id path Yes string
#Responses
Code Description
200 Success
default Error

#GET

#Description

Lists users

#Responses
Code Description
200 Success
default Error

#/api-token

#POST

#Description

Contains api token information

#Responses
Code Description
200 Success
default Error

#GET

#Description

Lists api tokens

#Responses
Code Description
200 Success
default Error

#/webhook

#GET

#Description

gets a list of webhooks defined by the user

#Responses
Code Description
200 Success
default Error

#POST

#Description

creates a new webhook

#Responses
Code Description
200 Success
default Error

#/webhook/{id}

#GET

#Description

gets a specific webhook details

#Parameters
Name Located in Description Required Schema
id path Yes string
#Responses
Code Description
200 Success
default Error

#PUT

#Description

updates a specific webhook

#Parameters
Name Located in Description Required Schema
id path Yes string
#Responses
Code Description
200 Success
default Error

#DELETE

#Description

deletes a specific webhook details

#Parameters
Name Located in Description Required Schema
id path Yes string
#Responses
Code Description
200 Success
default Error

#Models

#webhook

Name Type Description Required
id string Example: "de7818e7-610a-4057-8f6f-b785dc1e6f88" No
kind string Example: "webhook" No
name string Yes
userId string No
createdAt number Timestamp (in milliseconds) at which stream object was created<br>Example: 1587667174725 No
event string Enum: "streamStarted" Yes
url string Yes
deleted boolean No
blocking boolean If true, returning non 2xx value from webhook will prevent stream from starting No

#stream

Name Type Description Required
id string Example: "de7818e7-610a-4057-8f6f-b785dc1e6f88" No
kind string Example: "stream" No
name string Example: "test_stream" Yes
userId string Example: "66E2161C-7670-4D05-B71D-DA2D6979556F" No
lastSeen number Example: 1587667174725 No
sourceSegments number Example: 1 No
transcodedSegments number Example: 2 No
sourceSegmentsDuration number Duration of all the source segments, sec<br>Example: 1 No
transcodedSegmentsDuration number Duration of all the transcoded segments, sec<br>Example: 2 No
deleted boolean Set to true when stream deleted No
isActive boolean If currently active No
createdByTokenName string Name of the token used to create this object No
createdAt number Timestamp (in milliseconds) at which stream object was created<br>Example: 1587667174725 No
parentId string Points to parent stream object<br>Example: "de7818e7-610a-4057-8f6f-b785dc1e6f88" No
streamKey string Used to form RTMP ingest URL<br>Example: "hgebdhhigq" No
playbackId string Used to form playback URL<br>Example: "eaw4nk06ts2d0mzb" No
profiles [ object ] No
objectStoreId string Example: "D8321C3E-B29C-45EB-A1BB-A623D8BE0F65" No
presets [ string ] No
record boolean Should this stream be recorded? Uses default settings. For more customization, create and configure an object store.<br>Example: false No
recordObjectStoreId string ID of object store where to which this stream was recorded<br>Example: "D8321C3E-B29C-45EB-A1BB-A623D8BE0F65" No
wowza object No
renditions object No

#error

Name Type Description Required
errors [ string ] Yes

#object-store

Name Type Description Required
url string Livepeer-compatible object store URL<br>Example: "s3://access-key:[email protected]/bucket-name" Yes
id string Example: "09F8B46C-61A0-4254-9875-F71F4C605BC7" No
userId string Example: "66E2161C-7670-4D05-B71D-DA2D6979556F" No
name string No
createdAt number Timestamp (in milliseconds) at which object store object was created<br>Example: 1587667174725 No

#api-token

Name Type Description Required
kind string Example: "user" No
id string Example: "09F8B46C-61A0-4254-9875-F71F4C605BC7" No
userId string Example: "66E2161C-7670-4D05-B71D-DA2D6979556F" No
name string Example: "Example Token" No
lastSeen number Example: 1587667174725 No
createdAt number Timestamp (in milliseconds) at which token object was created<br>Example: 1587667174725 No

#user-verification

Name Type Description Required
email string user email address<br>Example: "[email protected]" Yes
emailValidToken string Example: "E1F53135E559C253" Yes

#password-reset-token

Name Type Description Required
email string user email address<br>Example: "[email protected]" Yes
userId string Example: "66E2161C-7670-4D05-B71D-DA2D6979556F" No

#make-admin

Name Type Description Required
email string user email address<br>Example: "[email protected]" Yes
admin boolean Example: true Yes

#create-customer

Name Type Description Required
email string user email address<br>Example: "[email protected]" Yes

#create-subscription

Name Type Description Required
stripeCustomerId string stripe customer id<br>Example: "cus_xxxxxxxxxxxxxx" Yes
stripeCustomerPaymentMethodId string stripe payment method id<br>Example: "src_xxxxxxxxxxxxxxxxxxxxxxxx" No
stripeProductId string stripe product id<br>Example: "prod_0" Yes

#update-subscription

Name Type Description Required
stripeCustomerId string stripe customer id<br>Example: "cus_xxxxxxxxxxxxxx" Yes
stripeCustomerSubscriptionId string stripe subscription id<br>Example: "sub_xxxxxxxxxxxxxx" No
stripeCustomerPaymentMethodId string stripe payment method id<br>Example: "pm_xxxxxxxxxxxxxxxxxxxxxxxx" No
stripeProductId string stripe product id<br>Example: "prod_0" Yes

#update-customer-payment-method

Name Type Description Required
stripeCustomerId string stripe customer id<br>Example: "cus_xxxxxxxxxxxxxx" Yes
stripeCustomerPaymentMethodId string stripe payment method id<br>Example: "pm_xxxxxxxxxxxxxxxxxxxxxxxx" Yes

#retrieve-customer-payment-method

Name Type Description Required
stripeCustomerPaymentMethodId string stripe payment method id<br>Example: "src_xxxxxxxxxxxxxxxxxxxxxxxx" Yes

#password-reset

Name Type Description Required
email string user email address<br>Example: "[email protected]" Yes
resetToken string Example: "E1F53135E559C253" Yes
password string Example: "thisisapassword" Yes
userId string Example: "66E2161C-7670-4D05-B71D-DA2D6979556F" No

#user

Name Type Description Required
email string user email address<br>Example: "[email protected]" Yes
password string Example: "thisisapassword" Yes
emailValidToken string Example: "E1F53135E559C253" No
emailValid boolean Example: true No
salt string Example: "E1F53135E559C253" No
admin boolean Example: true No
kind string Example: "user" No
id string Example: "abc123" No
firstName string Example: "Joe" No
lastName string Example: "Smith" No
organization string Example: "Livepeer" No
phone string Example: 2034212122 No
stripeProductId string Example: "prod_0" No
stripeCustomerId string Example: "cus_Jv6KvgT0DCH8HU" No
stripeCustomerPaymentMethodId string Example: "pm_2FSSNNJfrKDAwlJ9n4EN15Du" No
stripeCustomerSubscriptionId string Example: "sub_I29pdyfOTPBkjb" No
ccLast4 string Example: 1234 No
ccBrand string Example: 1234 No
Livepeer.com
beta
  • Company
  • Home
  • Contact
  • Team
  • Jobs
  • Livepeer Inc.
  • 16 Vestry Street, Floor 4
    New York, NY 10013
  • [email protected]