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
Data -- Parametric Tables
Embedded Peaka Api
Supported Drivers
Data -- Metadata
- GETGet Project Metadata
- PUTGenerate categorical values from the column.
- DELDelete categorical values from the column meta and remove the scheduled job
- GETSemantic query golden sqls for the project.
- GETList of golden sqls for the project.
- POSTCreate golden sql for the project
- DELDelete golden sql from the project.
- GETSemantic query metadata for the project.
- GETGenerate sample ai questions for the project
- POSTRefresh Project Metadata
- GETGet Metadata Refresh Job Callback
- POSTRegister Metadata Refresh Job Callback
- DELUnregister Metadata Refresh Job Callback
- GETGet Metadata Refresh Job Status
- GETGet Project Catalog Metadata Relations
- POSTAdd Relation To Metadata
- PUTUpdate Relation From Metadata
- DELDelete Relation From Metadata
- POSTGenerate semantics for the table
- PUTUpdate Metadata ai usage per catalog level
- PUTUpdate Metadata ai usage per schema level
- PUTUpdate Metadata
AI -- AgentV2
Data -- SQL
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": "<string>",
"schemaName": "<string>",
"tableName": "<string>",
"incrementalCacheSchedule": {
"expression": "<string>"
},
"fullRefreshCacheSchedule": {
"expression": "<string>"
}
}
]
'[
{
"success": true,
"error": "<string>",
"cache": {
"id": "<string>",
"catalogId": "<string>",
"schemaName": "<string>",
"tableName": "<string>",
"incrementalCacheSchedule": {
"expression": "<string>"
},
"fullRefreshCacheSchedule": {
"expression": "<string>"
},
"projectId": "<string>"
}
}
]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": "<string>",
"schemaName": "<string>",
"tableName": "<string>",
"incrementalCacheSchedule": {
"expression": "<string>"
},
"fullRefreshCacheSchedule": {
"expression": "<string>"
}
}
]
'[
{
"success": true,
"error": "<string>",
"cache": {
"id": "<string>",
"catalogId": "<string>",
"schemaName": "<string>",
"tableName": "<string>",
"incrementalCacheSchedule": {
"expression": "<string>"
},
"fullRefreshCacheSchedule": {
"expression": "<string>"
},
"projectId": "<string>"
}
}
]
Authorizations
Use the Authorization header with the value 'Bearer
Path Parameters
Body
Create Cache Request
The ID of the catalog for the cache request.
The name of the schema for the cache request.
The name of the table for the cache request.
This class represents a schedule for a materialized query.
Show child attributes
Show child attributes
The expression of the schedule. The expression is a duration in ISO-8601 format. "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
This class represents a schedule for a materialized query.
Show child attributes
Show child attributes
The expression of the schedule. The expression is a duration in ISO-8601 format. "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
Response
OK
Show child attributes
Show child attributes
The ID of the cache.
The ID of the catalog for the cache request.
The name of the schema for the cache request.
The name of the table for the cache request.
This class represents a schedule for a materialized query.
Show child attributes
Show child attributes
The expression of the schedule. The expression is a duration in ISO-8601 format. "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
This class represents a schedule for a materialized query.
Show child attributes
Show child attributes
The expression of the schedule. The expression is a duration in ISO-8601 format. "PT15M" -- parses as "15 minutes" (where a minute is 60 seconds) "PT10H" -- parses as "10 hours" (where an hour is 3600 seconds) "P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
The ID of the project for the cache request.