Skip to content
PIE V2 API

Overview

PIE API 2.0.0

Section titled “PIE API 2.0.0”

Pricing Intelligence Engine API (V2).

V2 exposes tenant-scoped clients, domains, services, assignments, jobs, and the global model registry. Protected routes use Cognito bearer tokens and check both operation permissions and tenant access. The servers list shows the production, staging, test, and local API bases.

Use the documentation link below for concepts, authentication, tenancy, workflows, and guides.

Concepts overview — clients, domains, authentication, tenancy, assignments, jobs, and end-to-end workflows.

Informations

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/v2/health
GET
/v2/clients
POST
/v2/clients
GET
/v2/clients/{client_id}
PUT
/v2/clients/{client_id}
PUT
/v2/clients/{client_id}/new_status
GET
/v2/clients/{client_id}/domains
POST
/v2/clients/{client_id}/domains
GET
/v2/clients/{client_id}/domains/{domain_id}
PUT
/v2/clients/{client_id}/domains/{domain_id}
PUT
/v2/clients/{client_id}/domains/{domain_id}/new_status
GET
/v2/clients/{client_id}/domains/{domain_id}/features
PUT
/v2/clients/{client_id}/domains/{domain_id}/features
POST
/v2/clients/{client_id}/domains/{domain_id}/model/assign
GET
/v2/clients/{client_id}/domains/{domain_id}/model
GET
/v2/models
POST
/v2/models
GET
/v2/models/{model_id}
PUT
/v2/models/{model_id}
POST
/v2/models/{model_id}/new_version
POST
/v2/models/{model_id}/versions/{model_version}/new_status
POST
/v2/models/{model_id}/versions/{model_version}/train
POST
/v2/models/{model_id}/versions/{model_version}/inference
GET
/v2/models/{model_id}/versions/{model_version}/jobs/{model_job_id}
POST
/v2/models/{model_id}/versions/{model_version}/jobs/{model_job_id}/complete
GET
/v2/models/{model_id}/event-subscriptions
POST
/v2/models/{model_id}/event-subscriptions
PUT
/v2/models/{model_id}/event-subscriptions/{subscription_id}
DELETE
/v2/models/{model_id}/event-subscriptions/{subscription_id}
POST
/v2/clients/{client_id}/domains/{domain_id}/services/init
POST
/v2/clients/{client_id}/domains/{domain_id}/service/init
GET
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}
PUT
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}
GET
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}/status
PUT
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}/new_status
GET
/v2/clients/{client_id}/domains/{domain_id}/assignments
POST
/v2/clients/{client_id}/domains/{domain_id}/assignments
GET
/v2/clients/{client_id}/domains/{domain_id}/assignments/{assignment_key}
PUT
/v2/clients/{client_id}/domains/{domain_id}/assignments/{assignment_key}
POST
/v2/clients/{client_id}/domains/{domain_id}/assignments/{assignment_key}/jobs
GET
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}/assignments
POST
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}/assignments
GET
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}/assignments/{assignment_key}
PUT
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}/assignments/{assignment_key}
POST
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}/assignments/{assignment_key}/jobs
GET
/v2/jobs/{job_id}

Authentication

Section titled “ Authentication ”

BearerAuth

Section titled “BearerAuth ”

Cognito-issued JWT. Issuer is the standard Cognito issuer for your user pool: https://cognito-idp.<region>.amazonaws.com/<user_pool_id>. Audience (aud) must match an app client id allowed by the API’s JWT configuration (human pool client and/or machine clients as configured).

Security scheme type: http

Bearer format: JWT