OpenAPI Specification

Machine-readable API specification for PlatformXe.

PlatformXe provides a full OpenAPI 3.1 specification that describes every endpoint, request body, response schema, and authentication requirement.

Specification URL

https://api.platformxe.com/api/docs/openapi.json

Importing into tools

Postman

1. Open Postman and click Import
2. Select Link and paste the URL: https://api.platformxe.com/api/docs/openapi.json
3. Click Import — Postman creates a collection with all endpoints
4. Set the x-api-key header in the collection variables

Swagger UI

Use the hosted Swagger UI to explore the API interactively:

https://api.platformxe.com/api/docs

Or run Swagger UI locally with Docker:

docker run -p 8080:8080 \
  -e SWAGGER_JSON_URL=https://api.platformxe.com/api/docs/openapi.json \
  swaggerapi/swagger-ui

Insomnia

1. Open Insomnia and click Import
2. Choose From URL and paste: https://api.platformxe.com/api/docs/openapi.json
3. Configure the x-api-key environment variable

Authentication

All endpoints require the x-api-key header:

curl https://api.platformxe.com/api/v1/permissions/roles \
  -H "x-api-key: pxk_live_your_api_key_here"

The OpenAPI spec defines this as an API key security scheme. When importing, configure your tool to include the header automatically.

Base URL

https://api.platformxe.com/api/v1

All endpoints are prefixed with /api/v1. The OpenAPI spec includes this in the servers array.

Response format

Every endpoint returns the standard PlatformXe envelope:

// Success
{ "success": true, "data": { ... } }

// Error
{ "success": false, "error": { "code": "NOT_FOUND", "message": "..." } }

Code generation

Generate a typed client from the spec:

npx openapi-generator-cli generate \
  -i https://api.platformxe.com/api/docs/openapi.json \
  -g typescript-fetch \
  -o ./generated-client

For TypeScript projects, we recommend using the official SDK instead of generated clients for the best developer experience.