Livepeer

Livepeer Orchestrator API

Orchestrator configuration and management

Documentation GitHub OpenAPI

Documentation

https://docs.livepeer.org

https://docs.livepeer.org/api-reference

https://docs.livepeer.org/quickstart

https://docs.livepeer.org/developers/authentication

https://docs.livepeer.org/ai

https://docs.livepeer.org/ai/api-reference

https://docs.livepeer.org/orchestrators/guides/install-go-livepeer

https://docs.livepeer.org/references/livepeer-cli

Specifications

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/openapi/livepeer-com-orchestrator-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/json-schema/livepeer-stream-schema.json

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/json-schema/livepeer-asset-schema.json

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/json-schema/livepeer-task-schema.json

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/json-schema/livepeer-webhook-schema.json

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/json-structure/livepeer-stream-structure.json

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/json-schema/livepeer-ai-text-to-image-schema.json

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/json-schema/livepeer-ai-image-to-video-schema.json

Other Resources

SpectralRuleset

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/rules/livepeer-studio-rules.yml

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/examples/livepeer-create-stream-example.json

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/examples/livepeer-create-webhook-example.json

SpectralRuleset

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/rules/livepeer-ai-rules.yml

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/examples/livepeer-ai-text-to-image-example.json

https://raw.githubusercontent.com/api-evangelist/livepeer-com/refs/heads/main/examples/livepeer-image-to-video-example.json

OpenAPI Specification

openapi: 3.1.0
info:
  title: Livepeer AI Runner accessControl Orchestrator API
  description: An application to run AI pipelines
  version: 0.0.0
servers:
- url: https://dream-gateway.livepeer.cloud
  description: Livepeer Cloud Community Gateway
- url: https://livepeer.studio/api/beta/generate
  description: Livepeer Studio Gateway
tags:
- name: Orchestrator
  description: Orchestrator configuration and management
paths:
  /activateOrchestrator:
    post:
      tags:
      - Orchestrator
      summary: Activate orchestrator
      description: Multi-step process to become an orchestrator
      operationId: activateOrchestrator
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - blockRewardCut
              - feeShare
              - pricePerUnit
              - serviceURI
              properties:
                blockRewardCut:
                  type: string
                  description: Percentage of block rewards to keep (0-100)
                  example: '10'
                feeShare:
                  type: string
                  description: Percentage of fees to share with delegators (0-100)
                  example: '5'
                pricePerUnit:
                  type: string
                  description: Price per pixel in wei
                  example: '1000'
                serviceURI:
                  type: string
                  description: Service URI for the orchestrator
                  example: https://orchestrator.example.com:8935
      responses:
        '200':
          description: Orchestrator activated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResponse'
  /reward:
    post:
      tags:
      - Orchestrator
      summary: Claim orchestrator rewards
      description: Claim orchestrator rewards for current round
      operationId: claimReward
      responses:
        '200':
          description: Reward claimed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResponse'
components:
  schemas:
    TransactionResponse:
      type: object
      properties:
        txHash:
          type: string
          description: Transaction hash
          example: 0x...
        status:
          type: string
          description: Transaction status
          example: success
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer