Skip to Content

Pricing

5 endpoints

POST /api/v5/artifacts/pricing/get

Get Pricing

Get pricing top chart — daily cost aggregation + filter options.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ start_date?: `string` | `null` end_date?: `string` | `null` date_from?: `string` | `null` date_to?: `string` | `null` }

Response:

{ daily?: `PricingDailyItem`[] resources?: `PricingResources` total_count?: `integer` model_options?: `FilterOption`[] agent_options?: `FilterOption`[] analytics?: `AnalyticsFacets` | `null` }

POST /api/v5/artifacts/pricing/search

Search Pricing

Get pricing group history (bottom table, paginated).

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ start_date?: `string` | `null` end_date?: `string` | `null` date_from?: `string` | `null` date_to?: `string` | `null` page?: `integer` page_size?: `integer` sort_order?: `string` }

Response:

{ data?: `PricingGroupItem`[] total_count?: `integer` page?: `integer` page_size?: `integer` total_pages?: `integer` }

POST /api/v5/artifacts/pricing/refresh

Pricing Refresh

Refresh pricing materialized views and invalidate caches.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Response:

{ success: `boolean` refreshed_views: `string`[] invalidated_tags: `string`[] }

POST /api/v5/artifacts/pricing/export

Export Pricing

Export all pricing data as a clean, denormalized ZIP.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Response:

{ upload_id: `string` file_name: `string` row_count: `integer` }

POST /api/v5/artifacts/pricing/docs

Get Pricing Docs Endpoint

Get composed documentation for the pricing analytics.

Parameters:

NameInRequiredDescription
X-Api-KeyheaderNo
authorizationheaderNo
X-MCPheaderNo

Request body:

{ entity_id?: `string` | `null` }

Response:

{ name: `string` type: `string` description: `string` artifact?: `DocsResponse` | `null` entries: `DocsResponse`[] resources: `DocsResponse`[] permissions: `OperationInfo`[] api_operations: `OperationInfo`[] page_metadata?: `DocsApiResponse` | `null` }

Last updated on