industry-department-solutions
latest
false
- Overview
- API Resources
Supply Chain & Retail Solutions API guide
Last updated Apr 16, 2026
Project
Overview
The project resource represents project entities in the B2B pricing application. This resource stores project information including categorization details.
Resource Endpoint
/api/v2/ingest/object/{prefix}PROJECT{suffix}
/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
| Attribute | Data Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Unique identifier for each project. Used to join project metadata to quotations and sales for model training and guardrails. |
updated_at | datetime | 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 | No | Project name. Used in the UI to identify projects. |
project_category | string | No | Project category. Used in model training as a feature to determine the optimal quote price. |
project_subcategory | string | No | 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"
}
{
"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://service.peak.ai/ingestion-api/api/v2/ingest/object/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"
}'
curl -X POST \
'https://service.peak.ai/ingestion-api/api/v2/ingest/object/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: Additional custom attributes can be added using the
/PROJECT/add-attributeendpoint - Data Validation: All attributes are validated according to their defined data types
Related Resources
- quote_line - Quote line items associated with projects