README

Unified API for QuantCDN Admin and QuantCloud Platform services

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/quantcdn/quant-php-client.git"
    }
  ],
  "require": {
    "quantcdn/quant-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/quant-client/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer (JWT) authorization: BearerAuth
$config = QuantClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new QuantClient\Api\AIServicesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$organisation = 'organisation_example'; // string | The organisation ID
$chat_inference_request = new \QuantClient\Model\ChatInferenceRequest(); // \QuantClient\Model\ChatInferenceRequest | Chat request with optional multimodal content blocks

try {
    $result = $apiInstance->chatInference($organisation, $chat_inference_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AIServicesApi->chatInference: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://dashboard.quantcdn.io

Class	Method	HTTP request	Description
AIServicesApi	chatInference	POST /api/v3/organizations/{organisation}/ai/chat	Chat inference via API Gateway (buffered responses) with multimodal support
AIServicesApi	chatInferenceStream	POST /api/v3/organizations/{organisation}/ai/chat/stream	Chat inference via streaming endpoint (true HTTP streaming) with multimodal support
AIServicesApi	createAISession	POST /api/v3/organizations/{organisation}/ai/sessions	Create a new chat session with multi-tenant isolation
AIServicesApi	deleteAISession	DELETE /api/v3/organizations/{organisation}/ai/sessions/{sessionId}	Delete a chat session
AIServicesApi	embeddings	POST /api/v3/organizations/{organisation}/ai/embeddings	Generate text embeddings for semantic search and RAG applications
AIServicesApi	getAIConfig	GET /api/v3/organizations/{organisation}/ai/config	Get AI configuration for an organization
AIServicesApi	getAISession	GET /api/v3/organizations/{organisation}/ai/sessions/{sessionId}	Get a specific chat session
AIServicesApi	getAIUsageStats	GET /api/v3/organizations/{organisation}/ai/usage	Get AI usage statistics
AIServicesApi	getToolExecutionStatus	GET /api/v3/organizations/{organisation}/ai/tools/executions/{executionId}	Get async tool execution status and result
AIServicesApi	imageGeneration	POST /api/v3/organizations/{organisation}/ai/image-generation	Generate images with Amazon Nova Canvas
AIServicesApi	listAIModels	GET /api/v3/organizations/{organisation}/ai/models	List available AI models for an organization
AIServicesApi	listAISessions	GET /api/v3/organizations/{organisation}/ai/sessions	List chat sessions with multi-tenant filtering
AIServicesApi	listAIToolNames	GET /api/v3/organizations/{organisation}/ai/tools/names	List tool names only (lightweight response)
AIServicesApi	listAITools	GET /api/v3/organizations/{organisation}/ai/tools	List available built-in tools for function calling
AIServicesApi	listToolExecutions	GET /api/v3/organizations/{organisation}/ai/tools/executions	List tool executions for monitoring and debugging
AIServicesApi	updateAIConfig	PUT /api/v3/organizations/{organisation}/ai/config	Update AI configuration for an organization
ApplicationsApi	createApplication	POST /api/v3/organizations/{organisation}/applications	Create a new application
ApplicationsApi	deleteApplication	DELETE /api/v3/organizations/{organisation}/applications/{application}	Delete an application
ApplicationsApi	getApplication	GET /api/v3/organizations/{organisation}/applications/{application}	Get a single application
ApplicationsApi	getEcrLoginCredentials	GET /api/v3/organizations/{organisation}/applications/ecr-login	Get ECR login credentials
ApplicationsApi	listApplications	GET /api/v3/organizations/{organisation}/applications	Get all applications for an organisation
BackupManagementApi	createBackup	POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}	Create a backup for an environment
BackupManagementApi	deleteBackup	DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}/{backupId}	Delete a backup
BackupManagementApi	downloadBackup	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}/{backupId}/download	Generate a download URL for a backup
BackupManagementApi	listBackups	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/backups/{type}	List backups for an environment
CommandsApi	createCommand	POST /api/v3/organizations/{organisation}/environments/{environment}/commands	Create a command for an environment
CommandsApi	getCommand	GET /api/v3/organizations/{organisation}/environments/{environment}/commands/{command}	Get a command
CommandsApi	listCommands	GET /api/v3/organizations/{organisation}/environments/{environment}/commands	Get all commands for an environment
ComposeApi	getEnvironmentCompose	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose	Get the compose file for an environment
ComposeApi	patchEnvironmentCompose	PATCH /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/compose	Partially Update Environment Compose Definition
ComposeApi	validateCompose	POST /api/v3/organizations/{organisation}/compose/validate	Validate a compose file
ContainersApi	listContainers	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers	Get the containers in an environment
ContainersApi	updateContainer	PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/containers/{container}	Update a container in an environment
CrawlerSchedulesApi	crawlerSchedulesAdd	POST /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules	Add a new schedule
CrawlerSchedulesApi	crawlerSchedulesDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule}	Delete a schedule
CrawlerSchedulesApi	crawlerSchedulesEdit	PATCH /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule}	Edit a schedule
CrawlerSchedulesApi	crawlerSchedulesList	GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules	List schedules for a crawler
CrawlerSchedulesApi	crawlerSchedulesShow	GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/schedules/{crawler_schedule}	Show a specific schedule
CrawlersApi	crawlersCreate	POST /api/v2/organizations/{organization}/projects/{project}/crawlers	Create a new crawler
CrawlersApi	crawlersDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}	Delete a crawler
CrawlersApi	crawlersGetRunById	GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/runs/{run_id}	Get a run by ID
CrawlersApi	crawlersGetRuns	GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/runs	Get all runs for a crawler
CrawlersApi	crawlersList	GET /api/v2/organizations/{organization}/projects/{project}/crawlers	List crawlers for the project
CrawlersApi	crawlersRead	GET /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}	Get details of a single crawler
CrawlersApi	crawlersRun	POST /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}/run	Run a crawler
CrawlersApi	crawlersUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/crawlers/{crawler}	Update a crawler
CronApi	createCronJob	POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron	Create a new cron job
CronApi	deleteCronJob	DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron}	Delete a cron job
CronApi	getCronJob	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron}	Get a cron job
CronApi	getCronRun	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron}/runs/{run}	Get a cron run
CronApi	listCronJobRuns	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron}/runs	Get all runs for a cron job
CronApi	listCronJobs	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron	Get all cron jobs for an environment
CronApi	updateCronJob	PATCH /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/cron/{cron}	Update a cron job
DomainsApi	domainsCreate	POST /api/v2/organizations/{organization}/projects/{project}/domains	Add a new domain
DomainsApi	domainsDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/domains/{domain}	Delete a domain
DomainsApi	domainsList	GET /api/v2/organizations/{organization}/projects/{project}/domains	List all domains for a project
DomainsApi	domainsRead	GET /api/v2/organizations/{organization}/projects/{project}/domains/{domain}	Get details of a single domain
DomainsApi	domainsRenew	POST /api/v2/organizations/{organization}/projects/{project}/domains/{domain}/renew	Renew the SSL certificate for a domain
EnvironmentsApi	createEnvironment	POST /api/v3/organizations/{organisation}/applications/{application}/environments	Create a new environment
EnvironmentsApi	deleteEnvironment	DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}	Delete an environment
EnvironmentsApi	getEnvironment	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}	Get a single environment
EnvironmentsApi	getEnvironmentLogs	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/logs	Get the logs for an environment
EnvironmentsApi	getEnvironmentMetrics	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/metrics	Get the metrics for an environment
EnvironmentsApi	listEnvironments	GET /api/v3/organizations/{organisation}/applications/{application}/environments	Get all environments for an application
EnvironmentsApi	listSyncOperations	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/sync/{type}	List the sync operations for an environment
EnvironmentsApi	syncToEnvironment	POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/sync/{type}	Perform a sync operation from a source environment to the current environment
EnvironmentsApi	updateEnvironment	PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}	Update Environment Compose Definition
EnvironmentsApi	updateEnvironmentState	PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/state	Update the state of an environment
HeadersApi	headersCreate	POST /api/v2/organizations/{organization}/projects/{project}/custom-headers	Create or update custom headers
HeadersApi	headersDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/custom-headers	Delete custom headers
HeadersApi	headersList	GET /api/v2/organizations/{organization}/projects/{project}/custom-headers	List custom headers for a project
KVApi	kVCreate	POST /api/v2/organizations/{organization}/projects/{project}/kv	Add a kv store
KVApi	kVDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}	Delete a kv store
KVApi	kVItemsCreate	POST /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items	Add an item to a kv store
KVApi	kVItemsDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}	Delete an item from a kv store
KVApi	kVItemsList	GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items	List items in a kv store
KVApi	kVItemsShow	GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}	Get an item from a kv store
KVApi	kVItemsUpdate	PUT /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}/items/{key}	Update an item in a kv store
KVApi	kVList	GET /api/v2/organizations/{organization}/projects/{project}/kv	List key-value stores
KVApi	kVShow	GET /api/v2/organizations/{organization}/projects/{project}/kv/{store_id}	Get a kv store
OrganizationsApi	organizationsList	GET /api/v2/organizations	Retrieve all organizations
OrganizationsApi	organizationsRead	GET /api/v2/organizations/{organization}	Get details of a single organization
ProjectsApi	projectsCreate	POST /api/v2/organizations/{organization}/projects	Create a new project
ProjectsApi	projectsDelete	DELETE /api/v2/organizations/{organization}/projects/{project}	Delete a project
ProjectsApi	projectsList	GET /api/v2/organizations/{organization}/projects	Retrieve all projects for an organization
ProjectsApi	projectsRead	GET /api/v2/organizations/{organization}/projects/{project}	Get details of a single project
ProjectsApi	projectsUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}	Update a project
PurgeApi	purgeCreate	POST /api/v2/organizations/{organization}/projects/{project}/purge	Purge cache via URL or cache keys
RulesApi	rulesAuthCreate	POST /api/v2/organizations/{organization}/projects/{project}/rules/auth	Create an authentication rule
RulesApi	rulesAuthDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule}	Delete an authentication rule
RulesApi	rulesAuthList	GET /api/v2/organizations/{organization}/projects/{project}/rules/auth	List authentication rules
RulesApi	rulesAuthRead	GET /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule}	Get details of an authentication rule
RulesApi	rulesAuthUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/rules/auth/{rule}	Update an authentication rule
RulesApi	rulesBotChallengeCreate	POST /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge	Create a bot challenge rule
RulesApi	rulesBotChallengeDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule}	Delete a bot challenge rule
RulesApi	rulesBotChallengeList	GET /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge	List bot challenge rules
RulesApi	rulesBotChallengeRead	GET /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule}	Get details of a bot challenge rule
RulesApi	rulesBotChallengeUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/rules/bot-challenge/{rule}	Update a bot challenge rule
RulesApi	rulesContentFilterCreate	POST /api/v2/organizations/{organization}/projects/{project}/rules/content-filter	Create a content filter rule
RulesApi	rulesContentFilterDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule}	Delete a content filter rule
RulesApi	rulesContentFilterList	GET /api/v2/organizations/{organization}/projects/{project}/rules/content-filter	List content filter rules
RulesApi	rulesContentFilterRead	GET /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule}	Get details of a content filter rule
RulesApi	rulesContentFilterUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/rules/content-filter/{rule}	Update a content filter rule
RulesApi	rulesCustomResponseCreate	POST /api/v2/organizations/{organization}/projects/{project}/rules/custom-response	Create a custom response rule
RulesApi	rulesCustomResponseDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule}	Delete a custom response rule
RulesApi	rulesCustomResponseList	GET /api/v2/organizations/{organization}/projects/{project}/rules/custom-response	List custom response rules
RulesApi	rulesCustomResponseRead	GET /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule}	Get details of a custom response rule
RulesApi	rulesCustomResponseUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/rules/custom-response/{rule}	Update a custom response rule
RulesApi	rulesFunctionCreate	POST /api/v2/organizations/{organization}/projects/{project}/rules/function	Create an edge function rule
RulesApi	rulesFunctionDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule}	Delete an edge function rule
RulesApi	rulesFunctionList	GET /api/v2/organizations/{organization}/projects/{project}/rules/function	List edge function rules
RulesApi	rulesFunctionRead	GET /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule}	Get details of an edge function rule
RulesApi	rulesFunctionUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/rules/function/{rule}	Update an edge function rule
RulesApi	rulesHeadersCreate	POST /api/v2/organizations/{organization}/projects/{project}/rules/headers	Create a header rule
RulesApi	rulesHeadersDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule}	Delete a header rule
RulesApi	rulesHeadersList	GET /api/v2/organizations/{organization}/projects/{project}/rules/headers	List header rules
RulesApi	rulesHeadersRead	GET /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule}	Get details of a header rule
RulesApi	rulesHeadersUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/rules/headers/{rule}	Update a header rule
RulesApi	rulesProxyCreate	POST /api/v2/organizations/{organization}/projects/{project}/rules/proxy	Create a proxy rule
RulesApi	rulesProxyDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule}	Delete a proxy rule
RulesApi	rulesProxyList	GET /api/v2/organizations/{organization}/projects/{project}/rules/proxy	List proxy rules
RulesApi	rulesProxyRead	GET /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule}	Get details of a proxy rule
RulesApi	rulesProxyUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/rules/proxy/{rule}	Update a proxy rule
RulesApi	rulesRedirectCreate	POST /api/v2/organizations/{organization}/projects/{project}/rules/redirect	Create a redirect rule
RulesApi	rulesRedirectDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule}	Delete a redirect rule
RulesApi	rulesRedirectList	GET /api/v2/organizations/{organization}/projects/{project}/rules/redirect	List redirect rules
RulesApi	rulesRedirectRead	GET /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule}	Get details of a redirect rule
RulesApi	rulesRedirectUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/rules/redirect/{rule}	Update a redirect rule
RulesApi	rulesServeStaticCreate	POST /api/v2/organizations/{organization}/projects/{project}/rules/serve-static	Create a serve static rule
RulesApi	rulesServeStaticDelete	DELETE /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule}	Delete a serve static rule
RulesApi	rulesServeStaticList	GET /api/v2/organizations/{organization}/projects/{project}/rules/serve-static	List serve static rules
RulesApi	rulesServeStaticRead	GET /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule}	Get details of a serve static rule
RulesApi	rulesServeStaticUpdate	PATCH /api/v2/organizations/{organization}/projects/{project}/rules/serve-static/{rule}	Update a serve static rule
SSHAccessApi	getSshAccessCredentials	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/ssh-access	Get SSH access credentials for an environment
ScalingPolicyApi	deleteScalingPolicy	DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/scaling-policies/{policyName}	Delete the scaling policy for an environment
ScalingPolicyApi	getScalingPolicies	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/scaling-policies	Get the scaling policies for an environment
ScalingPolicyApi	updateScalingPolicy	PUT /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/scaling-policies	Update the scaling policy for an environment
VariablesApi	bulkSetEnvironmentVariables	PUT /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables	Bulk set/replace environment variables
VariablesApi	deleteEnvironmentVariable	DELETE /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables/{api_variable}	Delete a variable
VariablesApi	listEnvironmentVariables	GET /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables	Get all variables for an environment
VariablesApi	updateEnvironmentVariable	PUT /api/v3/organizations/{api_organisation}/applications/{api_application}/environments/{api_environment}/variables/{api_variable}	Update a variable
VolumesApi	createVolume	POST /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes	Create a new volume
VolumesApi	deleteVolume	DELETE /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes/{volume}	Delete a volume
VolumesApi	getVolume	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes/{volume}	Get a volume
VolumesApi	listVolumes	GET /api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/volumes	Get all volumes for an environment

Models

Authorization

Authentication schemes defined for the API:

BearerAuth

Type: Bearer authentication (JWT)

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 4.4.0
- Package version: 4.4.0
- Generator version: 7.13.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

quantcdn / quant-php-client

Maintainers

Details