Highrise Builds API

The builds API from Highrise — 9 operation(s) for builds.

Operations 10

GET /api/build Get Bundle #
GET /api/worlds/{world_id}/builds Get Builds #
POST /api/worlds/{world_id}/builds Create World Build #
GET /api/worlds/{world_id}/builds/{build_number} Get Build #
GET /api/worlds/{world_id}/builds-paginated Get Builds Paginated #
PUT /api/worlds/{world_id}/builds/{build_number}/status Start Processing World Build #
PUT /api/worlds/{world_id}/builds/{build_number}/prebuilt Import Prebuilt World Build #
POST /api/worlds/{world_id}/builds/{build_number}/retire Retire Build #
POST /api/worlds/{world_id}/release Release Build #

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/highrise:highrise-builds-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.

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

OpenAPI Specification

highrise-builds-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Create Builds API
  version: '1.0'
tags:
- name: Builds
paths:
  /api/build:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBundleResponse'
      parameters:
      - name: bundle_id
        in: query
        required: true
        schema:
          type: string
      summary: Get Bundle
      tags:
      - Builds
      operationId: get_bundle
  /api/builds:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBundleLinksResponse'
      summary: Get Bundle Links
      tags:
      - Builds
      operationId: get_bundle_links
  /api/worlds/{world_id}/builds:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_PaginatedBuild'
      parameters:
      - name: world_id
        in: path
        required: true
        schema:
          type: string
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: integer
      security:
      - cookie/hr_s_production: []
      summary: Get Builds
      tags:
      - Builds
      operationId: get_builds
    post:
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateBuildResponse'
      parameters:
      - name: world_id
        in: path
        required: true
        schema:
          type: string
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      security:
      - cookie/hr_s_production: []
      summary: Create World Build
      tags:
      - Builds
      operationId: create_world_build
      description: Create a new build.
  /api/worlds/{world_id}/builds/{build_number}:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedBuild'
      parameters:
      - name: world_id
        in: path
        required: true
        schema:
          type: string
      - name: build_number
        in: path
        required: true
        schema:
          type: integer
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      security:
      - cookie/hr_s_production: []
      summary: Get Build
      tags:
      - Builds
      operationId: get_build
  /api/worlds/{world_id}/builds-paginated:
    get:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Table_PaginatedBuild'
      parameters:
      - name: world_id
        in: path
        required: true
        schema:
          type: string
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      - name: page
        in: query
        schema:
          type: integer
      security:
      - cookie/hr_s_production: []
      summary: Get Builds Paginated
      tags:
      - Builds
      operationId: get_builds_paginated
  /api/worlds/{world_id}/builds/{build_number}/status:
    put:
      responses:
        '204':
          description: No content
      parameters:
      - name: world_id
        in: path
        required: true
        schema:
          type: string
      - name: build_number
        in: path
        required: true
        schema:
          type: string
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      - name: unity_version
        in: query
        schema:
          type: string
      security:
      - cookie/hr_s_production: []
      summary: Start Processing World Build
      tags:
      - Builds
      operationId: start_processing_world_build
      description: 'Should be hit after the world bundle has been uploaded.


        We assume the new status is `processing`.'
  /api/worlds/{world_id}/builds/{build_number}/prebuilt:
    put:
      responses:
        '204':
          description: No content
      parameters:
      - name: world_id
        in: path
        required: true
        schema:
          type: string
      - name: build_number
        in: path
        required: true
        schema:
          type: integer
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      security:
      - cookie/hr_s_production: []
      summary: Import Prebuilt World Build
      tags:
      - Builds
      operationId: import_prebuilt_world_build
      description: 'Admin-only alternative to `start_processing_world_build`: the upload is a zip

        of an already-built Unity `Build/Publish` folder, stored as the build output

        without going through the Unity builder.'
  /api/worlds/{world_id}/builds/{build_number}/retire:
    post:
      responses:
        '204':
          description: No content
      parameters:
      - name: world_id
        in: path
        required: true
        schema:
          type: string
      - name: build_number
        in: path
        required: true
        schema:
          type: integer
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      security:
      - cookie/hr_s_production: []
      summary: Retire Build
      tags:
      - Builds
      operationId: retire_build
  /api/worlds/{world_id}/release:
    post:
      responses:
        '204':
          description: No content
      parameters:
      - name: world_id
        in: path
        required: true
        schema:
          type: string
      - name: hr_s_production
        in: cookie
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleaseBuildRequest'
        required: true
      security:
      - cookie/hr_s_production: []
      summary: Release Build
      tags:
      - Builds
      operationId: release_build
components:
  schemas:
    CreateBuildResponse:
      type: object
      properties:
        build_number:
          type: integer
        upload_url:
          type: string
      required:
      - build_number
      - upload_url
    ReleaseBuildRequest:
      type: object
      properties:
        version:
          type: string
        release_notes:
          oneOf:
          - type: string
          - type: 'null'
      required:
      - version
    Task:
      type: object
      properties:
        name:
          type: string
        status:
          type: string
          enum:
          - pending
          - running
          - completed
          - error
        message:
          oneOf:
          - type: string
          - type: 'null'
      required:
      - name
      - status
    SafeBuildResult:
      type: object
      properties:
        duration:
          type: integer
        template_version:
          type: string
        unity_version:
          type: string
        api_version:
          $ref: '#/components/schemas/WorldApiVersion'
        pipeline:
          items:
            $ref: '#/components/schemas/Pipeline'
          type: array
      required:
      - duration
      - template_version
      - unity_version
      - api_version
    Table_PaginatedBuild:
      type: object
      properties:
        elements:
          items:
            $ref: '#/components/schemas/PaginatedBuild'
          type: array
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
      required:
      - elements
      - total
      - limit
      - offset
    GetBundleResponse:
      type: object
      properties:
        build:
          type: integer
        version:
          type: string
        download_url:
          type: string
        download_page_url:
          type: string
      required:
      - build
      - version
      - download_url
      - download_page_url
    BuildLink:
      type: object
      properties:
        bundleId:
          type: string
        downloadUrl:
          type: string
      required:
      - bundleId
      - downloadUrl
    Pipeline:
      type: object
      properties:
        name:
          type: string
        status:
          type: string
          enum:
          - pending
          - running
          - completed
          - error
        tasks:
          items:
            $ref: '#/components/schemas/Task'
          type: array
        duration:
          type: integer
        message:
          oneOf:
          - type: string
          - type: 'null'
      required:
      - name
      - status
      - tasks
      - duration
    PaginatedBuild:
      type: object
      properties:
        id:
          type: string
        number:
          type: integer
        status:
          type: string
        updated_at:
          oneOf:
          - type: 'null'
        created_at:
          oneOf:
          - type: 'null'
        result:
          oneOf:
          - $ref: '#/components/schemas/SafeBuildResult'
          - type: 'null'
        can_retire:
          type: boolean
      required:
      - id
      - number
      - status
      - updated_at
      - created_at
      - result
    Page_PaginatedBuild:
      type: object
      properties:
        elements:
          items:
            $ref: '#/components/schemas/PaginatedBuild'
          type: array
        has_more:
          type: boolean
        total:
          oneOf:
          - type: integer
          - type: 'null'
      required:
      - elements
      - has_more
    GetBundleLinksResponse:
      type: object
      properties:
        builds:
          items:
            $ref: '#/components/schemas/BuildLink'
          type: array
      required:
      - builds
    WorldApiVersion:
      type: object
      properties:
        full:
          type: string
        major:
          type: integer
        minor:
          type: integer
        patch:
          type: integer
  securitySchemes:
    cookie_hr_s_production:
      name: hr_s_production
      in: cookie
      description: null
      type: apiKey
x-provenance:
  method: harvested
  publisher: Highrise
  source: https://create.highrise.game/api/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)