Skip to content
PIE V2 API

Initialize a new service

POST
/v2/clients/{client_id}/domains/{domain_id}/service/init
 
curl --request POST \
  --url https://pie.streamline.enterprises/v2/clients/client-1/domains/south_australia/service/init \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "service_id": "service-1", "departure_datetime": "2025-07-01T12:00:00Z", "static_features": { "route": "Adelaide to Sydney", "competitor_count": 5 } }'

Creates and initializes a service within the domain. Validates static features against domain feature definitions, applies defaults where not provided, then triggers inference on the domain’s assigned model.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
client_id
required
string
Example 
client-1
domain_id
required
string
Example 
south_australia

Request Body required

Section titled “Request Body required ”
Media type application/json
object
service_id
required
string
departure_datetime
required
string format: date-time
static_features

Feature key-value pairs. Mandatory features without defaults must be provided.

object
Example 
{
  "service_id": "service-1",
  "departure_datetime": "2025-07-01T12:00:00Z",
  "static_features": {
    "route": "Adelaide to Sydney",
    "competitor_count": 5
  }
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Service initialization started

Media type application/json
object
service_id
required
string
job_id
required

Durable model job ID for the initialization job.

string
Example 
{
  "service_id": "service-1",
  "job_id": "123456789012"
}

400

Section titled “400 ”

Validation error — malformed input, invalid path parameters, or request that fails syntactic validation.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

401

Section titled “401 ”

Missing or invalid Authorization bearer token, expired token, or token rejected by the authorization layer (e.g. API Gateway JWT authorizer or application validation).

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

403

Section titled “403 ”

Authenticated caller lacks the permission required for this operation.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

404

Section titled “404 ”

Requested resource was not found.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

422

Section titled “422 ”

Semantically invalid request — e.g. domain not active, no model assigned, feature contract mismatch, or invalid feature definitions.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}