The platform client requires the
platform extras:Configuration
Environment Variables
Set these environment variables before using the client:KodexaPlatform
KodexaPlatform provides static utility methods for managing configuration:
KodexaClient
The main entry point for API interactions:Available Endpoints
The client provides endpoint properties for all platform resources:Account Info
Working with Organizations
Working with Projects
CRUD Operations
All endpoint classes follow a consistent CRUD pattern:List with Pagination
Streaming (All Pages)
Iterate through all pages automatically:Get by ID
Create
Update
Delete
Working with Components
Component endpoints (modules, taxonomies, stores, etc.) support slug-based operations:Resource Resolution
The client uses the platform’s resolver to convert slug-based references to API paths:Working with Assistants
Working with Knowledge Items
Low-level HTTP Methods
For direct API access, the client exposes HTTP methods with built-in authentication:X-API-Key and cf-access-token headers.
