API reference

Base URL

https://api.pnplayer.com

All account endpoints live under /v1/api. Authentication and password endpoints live at the root (/auth/token, /password/reset, /password/change).

Authentication

Every /v1/api endpoint accepts either of two credentials.

API key (recommended)
Session token

Create a key in Settings → API keys in the dashboard, or with the Create an API key endpoint. Keys are prefixed pn_, act as the user who created them and stay valid until revoked.

curl https://api.pnplayer.com/v1/api/video \
  --header 'X-Auth-Token: pn_YOUR_API_KEY'

Exchange an email and password for a JWT that lasts 24 hours using Create a session token.

curl --request POST https://api.pnplayer.com/auth/token \
  --header 'Content-Type: application/json' \
  --data '{"email": "you@example.com", "password": "••••••••"}'

The response contains the token.

{ "token": "eyJhbGciOiJSUzI1NiIs..." }

Send it as a bearer token on later requests.

curl https://api.pnplayer.com/v1/api/video \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...'

Roles and scopes

Each team member holds a set of roles, and most endpoints require one of them. The required scope is listed on every endpoint page.

Scope	Grants
`READ_MEDIA`	List and read videos and playlists
`UPDATE_MEDIA`	Create, update and delete videos, captions, chapters and playlists
`READ_ANALYTICS`	Analytics endpoints
`READ_BILLING`	Billing overview and expansion packs
`READ_SETTINGS`	Read account settings
`UPDATE_SETTINGS`	Change account settings, API keys, webhooks and feature request status
`UPDATE_USERS`	Invite, update and remove team members

The account owner can manage API keys and webhooks regardless of roles. A request without the needed scope returns 403 with a message field.

Errors

Errors return a JSON body with a message describing the problem.

{ "message": "Forbidden" }

Status	Meaning
`400`	Missing or invalid input
`401`	Missing or invalid credentials
`403`	Authenticated, but the required scope is missing
`404`	The resource does not exist in your account
`409`	Conflict, such as a duplicate domain or an alignment job already running
`502`	An upstream media or transcription service rejected the request

Webhooks

PN Player can push signed event notifications to an HTTPS endpoint you control. Configure it with the Webhooks endpoints and see Event delivery for the payload format, signature verification and retry behaviour.

API documentation

Authentication

Videos

Captions

Playlists

Tags

Analytics

Reports

Account

Profile

API keys

Webhooks

Billing

Transcription settings

Feature requests

Agreements

Base URL

Authentication

Roles and scopes

Errors

Webhooks

​Base URL

​Authentication

​Roles and scopes

​Errors

​Webhooks

Base URL

Authentication

Roles and scopes

Errors

Webhooks