Project

project API resource representing project entities in the B2B pricing application, used for quote-based pricing categorization.

Overview

The project resource represents project entities in the B2B pricing application. This resource stores project information including categorization details.

→ For business context (purpose, usage notes, how this resource is used in the solution), see Projects dataset in the User Guide.

Resource Endpoint

/api/v2/ingest/object/{prefix}PROJECT{suffix}

Supported Methods

Method	Return Type	Description
POST	Response	Ingest (create/update) project records via UPSERT operation

Request Headers

Header	Required	Description
Authorization	Yes	Your Personal Access Token (PAT) from platform.peak.ai
Content-Type	Yes	Must be application/json

Properties

Primary Keys

• project_id (string) - Unique identifier for the project
• updated_at (datetime) - Timestamp of when the record was last updated

Attributes

About Required + Nullable: every attribute key must appear in each payload (Required: Yes). Nullable: Yes means the value can be null when you don't have data; Nullable: No means a non-null value is required. See Schema definition structure for the underlying rules.

Attribute	Data Type	Required	Nullable	Description
project_id	string	Yes	No	Unique identifier for each project. Used to join project metadata to quotations and sales for model training and guardrails.
updated_at	datetime	Yes	Yes	Timestamp when the record was updated. Used to identify the most up-to-date data in the UI and to match project metadata to the date of each quote in model training.
project_name	string	Yes	No	Project name. Used in the UI to identify projects.
project_category	string	Yes	Yes	Project category. Used in model training as a feature to determine the optimal quote price.
project_subcategory	string	Yes	Yes	Project sub-category. Used in model training as a feature to determine the optimal quote price.

Relationships

Outbound References

This resource has relationships to:

• quote_line - Projects can be associated with multiple quote lines

Inbound References

None

JSON Representation

{
  "solutionName": "QP_OOTB",
  "data": [
    {
      "project_id": "PROJ-001",
      "updated_at": "2025-01-28T10:00:00Z",
      "project_name": "Digital Transformation Initiative",
      "project_category": "IT",
      "project_subcategory": "Enterprise"
    }
  ],
  "operationType": "UPSERT"
}

Example Request

curl -X POST \
  'https://ingestion.peak.ai/api/v2/objects/QP_PROJECT_OOTB' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "solutionName": "QP_OOTB",
    "data": [
      {
        "project_id": "PROJ-001",
        "updated_at": "2025-01-28T10:00:00Z",
        "project_name": "Digital Transformation Initiative",
        "project_category": "IT",
        "project_subcategory": "Enterprise"
      }
    ],
    "operationType": "UPSERT"
  }'

Important Notes

• Custom Attributes: Custom attributes can be added with POST /api/v2/schema/{objectName}/add-attribute, where {objectName} is this table's fully qualified warehouse name ({prefix}PROJECT{suffix} — for example, QP_PROJECT_OOTB), as returned by Describe a solution's schema
• Data Validation: All attributes are validated according to their defined data types

Related Resources

• quote_line - Quote line items associated with projects