Skip to main content
POST
/
data
/
projects
/
{projectId}
/
cache
/
batch
Create Batch Cache
curl --request POST \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/cache/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "catalogId": "627249916703408649",
    "schemaName": "payment",
    "tableName": "customers"
  },
  {
    "catalogId": "627249916703408649",
    "schemaName": "payment",
    "tableName": "charges",
    "incrementalCacheSchedule": {
      "type": "BASIC",
      "expression": "PT6H"
    }
  },
  {
    "catalogId": "627249916703408649",
    "schemaName": "payment",
    "tableName": "invoices",
    "fullRefreshCacheSchedule": {
      "type": "BASIC",
      "expression": "PT24H"
    },
    "incrementalCacheSchedule": {
      "type": "BASIC",
      "expression": "PT6H"
    }
  }
]
'
[
  {
    "success": true,
    "error": "<string>",
    "cache": {
      "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 sources

Body

application/json

Array of cache creation requests. Each element specifies a table to cache with optional sync schedules.

​
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

200 - */*

Batch processing completed. Each entry in the response array indicates whether that specific cache was created successfully or failed.

​
success
boolean
​
error
string
​
cache
object