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

Pixie Scripts API

Operations for executing PxL scripts against a cluster and retrieving telemetry query results.

Pixie Scripts API is one of 5 APIs that Pixie publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, https://work.withpixie.ai.

1 operations 1 paths 9 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Server
https://work.withpixie.ai
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Pixie Scripts API declares 1 security scheme for authenticating requests. An API key is passed in the header as pixie-api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Pixie API key for authenticating requests. Generate an API key from the Pixie Cloud UI under Profile API Keys.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Scripts 1

Operations for executing PxL scripts against a cluster and retrieving telemetry query results.

POST
/api/pxl/execute
Pixie Execute a PxL script
executeScript body → 200400401404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ColumnData (5 properties), ExecuteScriptRequest (4 properties), Column (4 properties), ScriptStatus (3 properties). Each schema is shown below with its type and property counts.

ResultTable
object
A single tabular result set from a PxL script execution.
3 properties
Column
object
A column definition in a result table.
4 properties
ErrorResponse
object
Standard error response from the Pixie API.
3 properties
ExecuteScriptRequest
object
Request to execute a PxL script on a target cluster.
4 properties 2 required
ColumnData
object
Data values for a single column in a row batch.
5 properties
RowBatch
object
A batch of rows in a result table.
3 properties
ScriptStatus
object
Status of a script execution.
3 properties
Relation
object
Schema describing the columns of a result table.
1 property
ExecuteScriptResponse
object
Response containing the results of a PxL script execution.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pixie-scripts-api-openapi.yml Raw ↑

Other APIs Pixie publishes across the network.

Pixie PxL Script API
Pixie Plugin System API
Pixie Clusters API
Pixie Health API
Where this information came from

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