How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PixieBrix Copilot API

The copilot API from PixieBrix — 10 operation(s) for copilot.

PixieBrix Copilot API is one of 31 APIs that PixieBrix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Copilot. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 11 operations across 10 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://app.pixiebrix.com.

11 operations 10 paths 4 schemas 2 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://app.pixiebrix.com/api/
Resource Areas
1

Paths & Operations 11

Across 10 paths, the API surfaces 11 operations — 2 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

copilot 11
GET
/api/copilot/skills/{skill_id}/
Serve mod-generation copilot skill content (body only, front-matter stripped).
retrieveSkillDetail 1 param → 200
GET
/api/copilot/suggested-mod-prompts/
List suggested mod prompts (authenticated GET) or bulk upsert (POST with shared token).
listSuggestedModPrompts 2 params → 200
POST
/api/copilot/suggested-mod-prompts/
Bulk upsert prompts (shared-token auth for CI / automation).
createSuggestedModPromptBulkUpload body → 201
POST
/api/copilot/mod-generation/
Generate a new mod from a chat conversation, returning the AI assistant's reply (and any tool calls), optionally streamed as server-sent events.
createModGeneration body → 201
POST
/api/copilot/mod-edit/
API view for editing existing mods via AI copilot. Similar to ModGenerationView but uses a different system prompt optimized for editing existing mods rather than creating new ones from scratch.
createModEdit body → 201
POST
/api/copilot/chat/completions/
Stream a chat completion for the default chat copilot.
createChatCompletion body → 201
POST
/api/copilot/mod-generation/sessions/{id}/feedback/
Record the current user's feedback (rating and optional comment) on the mod-generation copilot session with the given id.
createModCopilotSessionFeedback 1 param body → 201
POST
/api/copilot/extract-from-page/
Extract structured data from page HTML or Markdown using AI, returning a result that conforms to the supplied JSON schema.
createExtractFromPage body → 201
POST
/api/copilot/custom-prompt/
Transform the provided input data with AI according to a custom prompt, returning a result that conforms to the supplied JSON schema.
createCustomPrompt body → 201
POST
/api/copilot/verify-mod/
Verify a mod definition against the conversation's requirements using AI, returning which acceptance criteria are implemented and which are missing.
createVerifyMod body → 201
PUT
/api/copilot/mod-generation/sessions/{id}/
Create or replace the mod-generation copilot session with the given id, storing its conversation and version metadata for the current user.
updateModCopilotSession 1 param body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ModCopilotSessionFeedback (8 properties), ModCopilotSession (8 properties), SuggestedModPrompt (5 properties), SuggestedModPromptBulkUpload (1 property). Each schema is shown below with its type and property counts.

SuggestedModPromptBulkUpload
object
1 property 1 required
ModCopilotSession
object
8 properties 1 required
ModCopilotSessionFeedback
object
8 properties 3 required
SuggestedModPrompt
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixiebrix-copilot-api-openapi.yml Raw ↑

Other APIs PixieBrix publishes across the network.

PixieBrix Activity API
PixieBrix Audit API
PixieBrix Bricks API
PixieBrix Campaigns API
PixieBrix Config API
PixieBrix Control Rooms API
PixieBrix Databases API
PixieBrix Deployments API
PixieBrix Events API
PixieBrix Groups API
PixieBrix Health API
PixieBrix Identify API
Where this information came from

This is an independent, third-party profile of PixieBrix Copilot API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.