Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Keboola Description API

The Description API from Keboola — 7 operation(s) for description.

Keboola Description API is one of 79 APIs that Keboola publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Description. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 17 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against the base URL https://connection.keboola.com/v2/storage.

7 operations 7 paths 17 schemas 7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://connection.keboola.com/v2/storage
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

Keboola Description API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-StorageApi-Token (ApiKeyAuth).

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 7 POST. Each is listed below with its method, path, parameters, and response codes.

Description 7
POST
/explain
Explain error message
explainError body → 201default
POST
/describe/configuration
Describe a configuration
describeConfiguration body → 201default
POST
/describe/configuration-version
Describe a configuration version change
describeConfigurationVersion body → 201default
POST
/describe/configuration-merge
Describe a configuration merge between branches
describeConfigurationMerge body → 201default
POST
/suggest/component
Suggest a component
suggestComponent body → 200default
POST
/feedback
Record feedback for a generated response.
feedback body → 202default
POST
/prompt/{templateId}
Generate a response using a specific prompt template
generatePromptResponse 1 param body → 201default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ConfigurationVersionRequest (6 properties), DescribeConfigurationFeedbackSubject (5 properties), ConfigurationDescriptionRequest (4 properties), ConfigurationMergeRequest (4 properties). Each schema is shown below with its type and property counts.

ConfigurationMergeRequest
object
Request to describe differences between a configuration in two branches. The base branch configuration may not exist (for newly created configurations).
4 properties 4 required
SuggestedComponent
object
2 properties 2 required
ComponentSuggestionsFeedbackSubject
object
2 properties 1 required
ExplainFeedbackSubject
object
2 properties 1 required
PromptRequest
object
1 property 1 required
Error
object
4 properties 3 required
ConfigurationVersionRequest
object
Provide the currentVersionId. If rowId is provided, the version IDs refer to row versions automatically. The previousVersionId is optional to support describin…
6 properties 4 required
ComponentSuggestion
object
2 properties 2 required
Feedback
object
4 properties 1 required
ComponentSuggestionRequest
object
1 property 1 required
ObjectDescription
object
2 properties 2 required
DescribeConfigurationFeedbackSubject
object
5 properties 3 required
ConfigurationVersionDescription
object
2 properties 2 required
ErrorExplanationRequest
object
2 properties 1 required
ConfigurationDescriptionRequest
object
4 properties 3 required
ErrorExplanation
object
2 properties 2 required
PromptResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keboola-description-api-openapi.yml Raw ↑

Other APIs Keboola publishes across the network.

Keboola Actions API
Keboola Admin Apps API
Keboola Admin Stacks API
Keboola Admin Users API
Keboola Admin Vendors API
Keboola App API
Keboola Auth API
Keboola Authorize API
Keboola Branch metadata API
Keboola Buckets API
Keboola Columns API
Keboola Component Configuration Metadata API