Authentication
Create an API key under Settings → API keys. Use a key withread
permission for discovery and add write permission to configure Connections.
The user who created the key must remain a workspace administrator.
Send the key as a bearer token:
Discover the API
GET /v1/ returns the current resource paths and methods for connector setup.
GET /v1/connectors returns the available connector catalog. Each connector
includes:
- supported authentication modes;
- JSON Schemas for public configuration and write-only credentials;
- operations and their read or edit effect;
- standard Capabilities supplied when the Connection becomes active.
Configure a BigQuery Connection
1. Create the Connection
integration.id for the following requests.
2. Add the credential
Use a dedicated service account with only the datasets Marina should read. The credential is write-only: API responses report whether a Connection is configured but never return credential values. If the service-account JSON is stored inservice-account.json, send only the
fields required by the connector schema:
3. Verify and activate
analytics.bigquery.query. Confirm the
published Capability with:
Connection endpoints
An
{integration} value may be a Connection ID or its unique name.
Errors
Errors use a stable JSON envelope:error.code as the
machine-readable category. Credential values are not included in error
responses.