PixieBrix

PixieBrix Settings API

The settings API from PixieBrix — 1 operation(s) for settings.

GitHub OpenAPI

Operations 2

PUT /api/settings/ #
PATCH /api/settings/ #

Documentation

📖
Documentation
https://docs.pixiebrix.com/developer-api
📖
APIReference
https://app.pixiebrix.com/api/docs/
📖
GettingStarted
https://docs.pixiebrix.com/developer-api/making-an-api-request
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/authentication/pixiebrix-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/rate-limits/pixiebrix-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/openapi/pixiebrix-settings-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/conventions/pixiebrix-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/errors/pixiebrix-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/pixiebrix/refs/heads/main/data-model/pixiebrix-data-model.yml

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/pixiebrix-settings-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

pixiebrix-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: PixieBrix Settings API
  version: 1.0.0
  description: PixieBrix admin and package registry API
  contact:
    name: PixieBrix Support
    email: support@pixiebrix.com
servers:
- url: https://app.pixiebrix.com
tags:
- name: settings
paths:
  /api/settings/:
    put:
      operationId: updateUserSettings
      description: Replace the authenticated user's account settings, including their publishing scope.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserSettings'
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/UserSettings'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/UserSettings'
          description: ''
      tags:
      - settings
    patch:
      operationId: partialUpdateUserSettings
      description: Update one or more of the authenticated user's account settings, such as their publishing scope.
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserSettings'
      responses:
        '200':
          content:
            application/json; version=1.0:
              schema:
                $ref: '#/components/schemas/UserSettings'
            application/vnd.pixiebrix.api+json; version=1.0:
              schema:
                $ref: '#/components/schemas/UserSettings'
          description: ''
      tags:
      - settings
components:
  schemas:
    UserSettings:
      type: object
      properties:
        scope:
          type:
          - string
          - 'null'
          pattern: ^@[a-z0-9][a-z0-9._-]*$
          maxLength: 128