Pieces

Pieces Well Known API

Health and version of the local Pieces OS instance.

GitHub OpenAPI

Operations 2

GET /.well-known/health Health check for the local Pieces OS instance. #
GET /.well-known/version Returns the running Pieces OS version. #

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-well-known-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-well-known-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-well-known-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Pieces OS Local Applications Well Known API
  description: The Pieces OS local REST API. Pieces OS is an on-device process that runs on the developer's machine and serves this API over the loopback interface at http://localhost:1000. It backs the Pieces Copilot, saved snippets (assets), local and cloud model management, and workspace context, and is the source of the official OpenAPI-generated SDKs. This document captures the core documented resources (assets, formats, copilot/QGPT, conversations, models, applications, user, and well-known). For the complete machine-generated specification see the upstream pieces-os-client-openapi-spec repository.
  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: Well Known
  description: Health and version of the local Pieces OS instance.
paths:
  /.well-known/health:
    get:
      operationId: getWellKnownHealth
      tags:
      - Well Known
      summary: Health check for the local Pieces OS instance.
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string
  /.well-known/version:
    get:
      operationId: getWellKnownVersion
      tags:
      - Well Known
      summary: Returns the running Pieces OS version.
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                type: string