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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PixieBrix

PixieBrix Databases API

The databases API from PixieBrix — 12 operation(s) for databases.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

Tagged areas include Databases. 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 22 operations across 12 paths, and defines 9 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.

22 operations 12 paths 9 schemas 3 DELETE10 GET2 PATCH5 POST2 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/
Contact
PixieBrix Support
Resource Areas
1

Paths & Operations 22

Across 12 paths, the API surfaces 22 operations — 3 DELETE, 10 GET, 2 PATCH, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

databases 22
GET
/api/databases/
Return the databases the authenticated user can access, whether personally owned or shared through a team.
listUserDatabases 2 params → 200
POST
/api/databases/
Create a new database owned by the authenticated user.
createUserDatabase body → 201
GET
/api/databases/records/jobs/{id}/
Return the status and result of a database-records export job, including any output file data or error message once the job finishes.
retrieveDatabaseExportJob 1 param → 200
GET
/api/databases/{id}/
Return a single database the authenticated user can access, including its name, type, and record statistics.
retrieveUserDatabase 1 param → 200
PATCH
/api/databases/{id}/
Update selected fields of a database the authenticated user owns, such as its name.
partialUpdateUserDatabase 1 param body → 200
DELETE
/api/databases/{id}/
Permanently delete a database, and all of its records, owned by the authenticated user.
destroyUserDatabase 1 param → 204
GET
/api/databases/{id}/permissions/
Return the authenticated user's effective permissions (such as read and write) for a single database.
retrieveUserDatabasePermission 1 param → 200
GET
/api/databases/{database_pk}/records/
Return the key/value records stored in the given database, newest first when previewing.
listRecords 3 params → 200
POST
/api/databases/{database_pk}/records/
Add one record, or several records in a single request, to the database, merging data into any existing record with the same key according to the chosen merge strategy.
createRecord 1 param body → 201
PUT
/api/databases/{database_pk}/records/
Replace or merge a record in the database (creating it if it does not yet exist), targeting a single record when a key is provided in the path or one or more records supplied in the request body.
updateRecord 1 param body → 200
DELETE
/api/databases/{database_pk}/records/
Delete every record in the database, optionally limited by query filters.
clearRecord 1 param → 204
GET
/api/databases/{database_pk}/records/{key}/
Return a single record from the database identified by its key.
retrieveRecordDetail 2 params → 200
PUT
/api/databases/{database_pk}/records/{key}/
Replace or merge a record in the database (creating it if it does not yet exist), targeting a single record when a key is provided in the path or one or more records supplied in the request body.
updateRecordDetail 2 params body → 200
DELETE
/api/databases/{database_pk}/records/{key}/
Delete a single record from the database identified by its key.
destroyRecordDetail 2 params → 204
GET
/api/databases/{database_pk}/assets/
Return the file assets (such as uploaded images) attached to a database, including each asset's filename, upload status, and download URL.
listAssets 3 params → 200
POST
/api/databases/{database_pk}/assets/
Register a new file asset on a database and return a presigned URL the client uses to upload the file directly to cloud storage.
createAssetPreUpload 1 param body → 201
GET
/api/databases/{database_pk}/assets/{id}/
Return a single database asset by id; by default redirects to the asset's file download, or returns the asset's metadata when requested.
retrieveAsset 2 params → 200
PATCH
/api/databases/{database_pk}/assets/{id}/
Update an existing database asset, for example to mark it as uploaded after the file has been stored.
partialUpdateAsset 2 params body → 200
GET
/api/databases/{database_pk}/references/
List bricks that use a database.
listDatabaseReferences 3 params → 200
GET
/api/databases/{database_pk}/deployments/
List deployments that use a database.
listDatabaseDeployments 3 params → 200
POST
/api/databases/records/jobs/
Start an asynchronous job that exports the records from one or more databases to a downloadable file (JSON, CSV, or XLSX), returning the new job's id and initial status.
createDatabaseExportJob body → 201
POST
/api/databases/{database_pk}/queue/assign/
Get the next available item in a queue. Runs as an atomic operation so multiple clients don't get assigned the same task.
createQueueAssign 1 param body → 201

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Deployment (14 properties), Database (10 properties), PackageVersionSlim (6 properties), Asset (6 properties). Each schema is shown below with its type and property counts.

DatabaseExportJob
object
5 properties 1 required
Database
object
10 properties 1 required
AssetPreUpload
object
3 properties 3 required
PackageVersionSlim
object
6 properties 3 required
Deployment
object
14 properties 3 required
Asset
object
6 properties
Record
object
4 properties 2 required
DatabaseExportRequest
object
4 properties 2 required
UserDatabasePermission
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixiebrix-databases-api-openapi.yml Raw ↑

Other APIs PixieBrix publishes across the network.

PixieBrix Activity API
AE Profile APIs.io
PixieBrix Audit API
AE Profile APIs.io
PixieBrix Bricks API
AE Profile APIs.io
PixieBrix Campaigns API
AE Profile APIs.io
PixieBrix Config API
AE Profile APIs.io
PixieBrix Control Rooms API
AE Profile APIs.io
PixieBrix Copilot API
AE Profile APIs.io
PixieBrix Deployments API
AE Profile APIs.io
PixieBrix Events API
AE Profile APIs.io
PixieBrix Groups API
AE Profile APIs.io
PixieBrix Health API
AE Profile APIs.io
PixieBrix Identify API
AE Profile APIs.io
#Databases
← Back to P APIs
API Details
ID
pixiebrix:pixiebrix-databases-api
Base URL
https://app.pixiebrix.com/api/
Docs
https://docs.pixiebrix.com/developer-api
Provider
PixieBrix
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pixiebrix-databases-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pixiebrix-databases-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of PixieBrix Databases 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.