Pieces

Pieces Models API

Local and cloud LLMs available to Pieces OS.

GitHub OpenAPI

Operations 5

GET /models List the models available to Pieces OS #
GET /model/{model} Get a single model by identifier #
POST /model/{model}/download Download a local model to the device #
POST /model/{model}/load Load a downloaded local model into memory #
POST /model/{model}/unload Unload a local model from memory #

Documentation

📖
Documentation
https://docs.pieces.app/products/core-dependencies/pieces-os
📖
APIReference
https://github.com/pieces-app/pieces-os-client-openapi-spec

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pieces/refs/heads/main/openapi/pieces-models-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/pieces/refs/heads/main/asyncapi/pieces-asyncapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/pieces/refs/heads/main/collections/pieces.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/pieces/refs/heads/main/collections/pieces.opencollection.json
🔗
GitHub
https://github.com/pieces-app

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/pieces-models-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

pieces-models-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pieces OS Local Models API
  description: The Pieces OS local REST API.
  termsOfService: https://pieces.app/legal/terms
  contact:
    name: Pieces Support
    url: https://docs.pieces.app
  version: '1.0'
servers:
- url: http://localhost:1000
  description: Default on-device Pieces OS port (loopback only).
- url: http://localhost:5323
  description: Alternate on-device Pieces OS port.
tags:
- name: Models
  description: Local and cloud LLMs available to Pieces OS.
paths:
  /models:
    get:
      operationId: getModelsSnapshot
      tags:
      - Models
      summary: List the models available to Pieces OS
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Models'
  /model/{model}:
    get:
      operationId: getModel
      tags:
      - Models
      summary: Get a single model by identifier
      parameters:
      - name: model
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model'
  /model/{model}/download:
    post:
      operationId: downloadModel
      tags:
      - Models
      summary: Download a local model to the device
      parameters:
      - name: model
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /model/{model}/load:
    post:
      operationId: loadModel
      tags:
      - Models
      summary: Load a downloaded local model into memory
      parameters:
      - name: model
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
  /model/{model}/unload:
    post:
      operationId: unloadModel
      tags:
      - Models
      summary: Unload a local model from memory
      parameters:
      - name: model
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
components:
  schemas:
    Model:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        cloud:
          type: boolean
        downloaded:
          type: boolean
        loaded:
          type: boolean
    Models:
      type: object
      properties:
        iterable:
          type: array
          items:
            $ref: '#/components/schemas/Model'