canonical: https://jentic.com/apis/soda.io/soda

# Soda Cloud REST API

Soda Cloud REST API for managing datasets and retrieving check results. Supports two cloud regions: EU (cloud.soda.io) and US (cloud.us.soda.io). The API exposes 2 endpoints secured with basic authentication.

## For AI agents

Programmatically create or update dataset data, retrieve check results. Covers 2 operations with basic authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Create or update dataset data
- Retrieve check results
- Integrate Soda Cloud REST API into automated workflows
- Query and filter Soda Cloud REST API records by parameters
- Monitor Soda Cloud REST API operational status and events

## Use cases

### Developer Tools Operations

Use the Soda Cloud REST API to perform developer tools operations programmatically. The API provides 2 endpoints covering core functionality including create or update dataset data, retrieve check results.

Example prompt: Call POST `/api/v1/datasets/{datasetId}` to create or update dataset data

### Data Retrieval and Monitoring

Query Soda Cloud REST API resources on a schedule to track changes, generate alerts, or feed downstream dashboards. Agents poll relevant endpoints, compare against previous state, and trigger actions when thresholds are crossed.

Example prompt: Poll the primary Soda Cloud REST API endpoint, compare response to last known state, and alert if changed

### AI Agent Integration via Jentic

AI agents discover and call Soda Cloud REST API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle basic tokens manually.

Example prompt: Search Jentic for 'create or update dataset data', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/api/v1/datasets/{datasetId}` | Create or update dataset data |
| GET | `/api/v1/checks` | Retrieve check results |

## Key resources

- **Datasets** — Operations related to dataset management
- **Checks** — Operations related to data quality checks

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 41 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 94 / 100
  - Developer Experience & Jentic Compatibility: 64 / 100
  - AI-Readiness & Agent Experience: 58 / 100
  - Agent Usability: 94 / 100
  - Security: 10 / 100
  - AI Discoverability: 69 / 100
- **View full report:** https://jentic.com/apis/soda.io/soda/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Soda Cloud REST API by hand means sending HTTP basic credentials on every request, choosing between the US and default cloud.soda.io hosts, and shaping the dataset payloads yourself. Through Jentic you install once, import the Soda Cloud REST API from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** The Soda Cloud REST API puts the dataset id in the URL path (`/api/v1/datasets/{datasetId}`), so a rule can pin your agent to one dataset: it can update that dataset's data and nothing else. You choose the operations it may call, so reading checks is only included if you add it.
- **Credential handling:** Your Soda Cloud REST API credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'update dataset data' or 'list quality checks', and Jentic returns the matching Soda Cloud REST API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Soda Cloud REST API use?

The Soda Cloud REST API uses HTTP Basic authentication with username and password. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I create or update dataset data with the Soda Cloud REST API?

Yes. Use the POST `/api/v1/datasets/{datasetId}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Soda Cloud REST API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I create or update dataset data through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create or update dataset data'. Jentic returns the matching Soda Cloud REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Soda Cloud REST API have?

The Soda Cloud REST API exposes 2 endpoints covering datasets, checks operations.

### Can I limit what my agent is allowed to do with the Soda Cloud REST API?

Yes. Because Jentic One is self-hosted, your own rules decide which Soda Cloud operations and credentials your agent may use. Since the dataset id sits in the URL path (POST `/api/v1/datasets/{datasetId}`), you can pin the agent to a single dataset so it updates that dataset's data and nothing else. You also choose the operations it may call, so reading check results via GET `/api/v1/checks` is included only if you add it.