Overview
PIE V2 separates the model registry from the tenant context used to run models. Most consumers work with tenant-scoped resources: a client owns domains, domains contain services, and domains or services expose stable assignment keys that run a model version.
Core objects
Section titled “Core objects”- Client: A registry tenant. The
client_idappears in paths under/v2/clients/{client_id}and is also used for tenant authorization. - Domain: A business scope under a client. Domains define the features needed to initialize services and can hold domain-scoped assignments.
- Service: A concrete service within a domain. A service stores provided features, resolved defaults, status, and service-scoped assignments.
- Model: A reusable definition in the global model registry. Models have one or more versions.
- Model version: A runnable version with handlers, status, and metadata.
- Assignment: A stable key such as
defaultorforecastthat points to one active model version in a domain or service scope. - Job: A durable async training or inference record. Jobs store input, output, error details, status, timestamps, and optional assignment context.
Relationship map
Section titled “Relationship map”flowchart TB
subgraph tenancy [Tenant context]
Client[Client]
Domain[Domain]
DomainFeatures[Domain features]
Service[Service]
end
subgraph engine [Model registry]
Model[Model]
Version[Model version]
Assignment[Model assignment]
Job[Model job]
Subscription[Event subscription]
end
Client --> Domain
Domain --> DomainFeatures
Domain --> Service
Domain --> Assignment
Service --> Assignment
Model --> Version
Assignment --> Version
Version --> Job
Assignment --> Job
Model --> Subscription
The normal consumer path
Section titled “The normal consumer path”- Obtain a JWT from Cognito.
- Use the correct
client_idfor your tenant. - Create or read a domain.
- Initialize a service or use an existing one.
- Run inference through an assignment key.
- Poll the returned job until it reaches
successorfailure.
Use direct model routes when you are managing the model registry itself. Use domain and service assignment routes when you are integrating a business workflow.