Skip to main content
POST
/
data
/
projects
/
{projectId}
/
cache
curl --request POST \ --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "id": "960bd651-7b3c-4511-9a88-18e14ac7742a", "catalogId": "627249916703408649", "schemaName": "payment", "tableName": "customers" } '
{
  "id": "<string>",
  "catalogId": "<string>",
  "schemaName": "<string>",
  "tableName": "<string>",
  "incrementalCacheSchedule": {
    "expression": "<string>"
  },
  "fullRefreshCacheSchedule": {
    "expression": "<string>"
  },
  "projectId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

The unique identifier of the project that owns the data source

Body

application/json

Cache creation request specifying the target table and optional sync schedules

This class represents a request to cache data. It contains the catalog ID, schema name, table name, and schedule of the cache request.

​
catalogId
string

The ID of the catalog for the cache request.

​
schemaName
string

The name of the schema for the cache request.

​
tableName
string

The name of the table for the cache request.

​
incrementalCacheSchedule
object

This class represents a schedule for a materialized query.

​
fullRefreshCacheSchedule
object

This class represents a schedule for a materialized query.

Response

Cache created successfully. Returns the created cache configuration including its generated ID and schedules.

​
id
string

The ID of the cache.

​
catalogId
string

The ID of the catalog for the cache request.

​
schemaName
string

The name of the schema for the cache request.

​
tableName
string

The name of the table for the cache request.

​
incrementalCacheSchedule
object

This class represents a schedule for a materialized query.

​
fullRefreshCacheSchedule
object

This class represents a schedule for a materialized query.

​
projectId
string

The ID of the project for the cache request.