API Documentation
Organization -> Organizations
Organization -> Workspaces
Organization -> Projects
Projects (Deprecated)
Projects -> Api Key
Connections
Data -> Catalogs
Data -> Internal Tables
Data -> Queries
Data -> Semantic Catalogs
Data -> Cache
Embedded Peaka Api
Supported Drivers
Data -> Metadata
- PUTUpdate Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- PUTGenerate categorical values from the the column.
- POSTGenerate semantics for the table
- POSTAdd Relation To Metadata
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- GETGet Project Metadata
- GETGet Project Catalog Metadata Relations
- GETGenerate sample ai questions for the project
- DELDelete golden sql from the project.
Data -> Cache
Create Batch Cache
POST
/
data
/
projects
/
{projectId}
/
cache
/
batch
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>",
"appId": "<string>",
"catalogId": "<string>",
"schemaName": "<string>",
"tableName": "<string>",
"incrementalCacheSchedule": {
"expression": "<string>"
},
"fullRefreshCacheSchedule": {
"expression": "<string>"
}
}
}
]
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Body
application/json · object[]
Create Cache Request
The body is of type object[]
.
Response
200 - */*
OK
The response is of type object[]
.
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>",
"appId": "<string>",
"catalogId": "<string>",
"schemaName": "<string>",
"tableName": "<string>",
"incrementalCacheSchedule": {
"expression": "<string>"
},
"fullRefreshCacheSchedule": {
"expression": "<string>"
}
}
}
]