Data -- Catalogs

Create Catalog

Creates a new catalog in the specified project. A catalog represents a connected data source — such as Airtable, Stripe, or Google Sheets — that exposes its schemas and tables for querying within Peaka. Requires a name and a connectionId referencing an existing connection. Some connectors accept additional extraParameters (e.g., Google Sheets requires specifying which sheets to include).

post/data/projects/{projectId}/catalogs

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/data/projects/{projectId}/catalogs
  • Auth: HTTP bearer

Path parameters

projectIdstring required

ID of the project

Request body

namestring

Name of the catalog

connectionIdstring

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.

extraParametersobject

Extra parameters for the catalog

Response

Catalog created successfully

idstring

The ID of the catalog.

namestring

The name of the catalog.

displayNamestring

The display name of the catalog.

catalogTypestring

The type of the catalog.

connectionIdstring

The connection ID of the catalog.

Changes

No recorded changes to this operation across all 1 revision of this API.