Skip to main content
POST
/
data
/
projects
/
{projectId}
/
catalogs
curl --request POST \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "exampleAirtableCatalog",
  "connectionId": "8db17e23-29de-4dab-8886-af9717e0e742"
}
'
{
  "id": "626654862255325504",
  "name": "exampleairtablecatalog",
  "displayName": "exampleAirtableCatalog",
  "catalogType": "airtable",
  "connectionId": "8db17e23-29de-4dab-8886-af9717e0e742"
}

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

ID of the project

Body

application/json

Catalog Request

​
name
string

Name of the catalog

​
connectionId
string

Connection ID.

This is the ID of the connection that is used to connect to the catalog.

You must create a connection before creating a catalog.

​
extraParameters
object

Extra parameters for the catalog

Response

Catalog created successfully

This class represents a Catalog. It contains the id, name, display name, type, and connection ID of the catalog.

​
id
string

The ID of the catalog.

​
name
string

The name of the catalog.

​
displayName
string

The display name of the catalog.

​
catalogType
string

The type of the catalog.

​
connectionId
string

The connection ID of the catalog.