Academy Software Foundation

Academy Software Foundation Jobs API

Manage render jobs submitted to the render farm

GitHub OpenAPI

Operations 3

GET /api/show/{show_id}/job Academy Software Foundation List Jobs for Show #
GET /api/job/{job_id} Academy Software Foundation Get Job #
DELETE /api/job/{job_id} Academy Software Foundation Kill Job #

Documentation

📖
Documentation
https://www.opencue.io/docs/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/academy-software-foundation/refs/heads/main/openapi/academy-software-foundation-jobs-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/AcademySoftwareFoundation/OpenCue

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/academy-software-foundation/refs/heads/main/json-schema/opencue-job-schema.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/academy-software-foundation/refs/heads/main/overlays/academy-software-foundation-jobs-api-overlay.yaml
🔗
Protobuf
https://raw.githubusercontent.com/api-evangelist/academy-software-foundation/refs/heads/main/grpc/academy-software-foundation-grpc.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/academy-software-foundation/refs/heads/main/examples/opencue-job-example.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/academy-software-foundation-jobs-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

academy-software-foundation-jobs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Academy Software Foundation - OpenCue Hosts Jobs API
  description: OpenCue is an open source render management system developed by Sony Pictures Imageworks and hosted by the Academy Software Foundation. This specification documents the gRPC/REST API surface for managing render jobs, layers, frames, hosts, shows, and subscriptions in an OpenCue render farm deployment.
  version: 1.0.0
  contact:
    url: https://www.opencue.io/
  x-generated-from: documentation
servers:
- url: http://localhost:8080
  description: Local OpenCue REST gateway (default port)
- url: http://opencue-gateway:8080
  description: OpenCue REST gateway in containerized deployment
security: []
tags:
- name: Jobs
  description: Manage render jobs submitted to the render farm
paths:
  /api/show/{show_id}/job:
    get:
      operationId: listJobs
      summary: Academy Software Foundation List Jobs for Show
      description: List all pending, running, and recently finished jobs for a show.
      tags:
      - Jobs
      parameters:
      - name: show_id
        in: path
        required: true
        description: The show identifier
        schema:
          type: string
        example: show-abc123
      - name: state
        in: query
        required: false
        description: Filter jobs by state (PENDING, RUNNING, FINISHED, PAUSED)
        schema:
          type: string
          enum:
          - PENDING
          - RUNNING
          - FINISHED
          - PAUSED
        example: RUNNING
      responses:
        '200':
          description: List of jobs for the show
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobList'
              examples:
                listJobs200Example:
                  summary: Default listJobs 200 response
                  x-microcks-default: true
                  value:
                    jobs:
                    - id: job-def456
                      name: feature_film_2026-shot_001-render_v001
                      show: feature_film_2026
                      state: RUNNING
                      priority: 100
                      totalFrames: 100
                      doneFrames: 45
                      runningFrames: 8
                      deadFrames: 0
                      waitingFrames: 47
        '404':
          description: Show not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /api/job/{job_id}:
    get:
      operationId: getJob
      summary: Academy Software Foundation Get Job
      description: Get details for a specific render job.
      tags:
      - Jobs
      parameters:
      - name: job_id
        in: path
        required: true
        description: The job identifier
        schema:
          type: string
        example: job-def456
      responses:
        '200':
          description: Job details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
              examples:
                getJob200Example:
                  summary: Default getJob 200 response
                  x-microcks-default: true
                  value:
                    id: job-def456
                    name: feature_film_2026-shot_001-render_v001
                    show: feature_film_2026
                    state: RUNNING
                    priority: 100
                    totalFrames: 100
                    doneFrames: 45
                    runningFrames: 8
                    deadFrames: 0
                    waitingFrames: 47
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: killJob
      summary: Academy Software Foundation Kill Job
      description: Kill a running or paused render job.
      tags:
      - Jobs
      parameters:
      - name: job_id
        in: path
        required: true
        description: The job identifier to kill
        schema:
          type: string
        example: job-def456
      responses:
        '200':
          description: Job killed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '404':
          description: Job not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    SuccessResponse:
      type: object
      description: Generic success response
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Operation completed successfully
    Job:
      type: object
      description: A render job in OpenCue
      properties:
        id:
          type: string
          description: Unique job identifier
          example: job-def456
        name:
          type: string
          description: Full job name
          example: feature_film_2026-shot_001-render_v001
        show:
          type: string
          description: Show name this job belongs to
          example: feature_film_2026
        state:
          type: string
          description: Current job state
          example: RUNNING
          enum:
          - PENDING
          - RUNNING
          - FINISHED
          - PAUSED
        priority:
          type: integer
          description: Job priority (higher is more important)
          example: 100
        totalFrames:
          type: integer
          description: Total number of frames in the job
          example: 100
        doneFrames:
          type: integer
          description: Number of completed frames
          example: 45
        runningFrames:
          type: integer
          description: Number of currently running frames
          example: 8
        deadFrames:
          type: integer
          description: Number of failed/dead frames
          example: 0
        waitingFrames:
          type: integer
          description: Number of frames waiting to be dispatched
          example: 47
    ErrorResponse:
      type: object
      description: Error response
      properties:
        error:
          type: string
          description: Error message
          example: Job not found
        code:
          type: integer
          description: Error code
          example: 404
    JobList:
      type: object
      description: List of jobs
      properties:
        jobs:
          type: array
          items:
            $ref: '#/components/schemas/Job'