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

# RestDB.io REST API

RestDB.io provides a simple REST API for managing NoSQL cloud database collections, documents, media, and sending emails. The API exposes 20 endpoints secured with apiKey authentication.

## For AI agents

Programmatically create a new document or bulk insert, list all documents in a collection. Covers 20 operations with apiKey authentication.

## Scope

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

## Capabilities

- Create a new document or bulk insert
- List all documents in a collection
- Get a single document by ID
- Replace an entire document
- Update specific properties on a document
- Delete a single document

## Use cases

### Communications Operations

Use the RestDB.io REST API to perform communications operations programmatically. The API provides 20 endpoints covering core functionality including create a new document or bulk insert, list all documents in a collection, get a single document by id.

Example prompt: Call POST `/rest/{collection}` to create a new document or bulk insert

### Automated Collections Management

Automate collections operations by combining multiple RestDB.io REST API endpoints. Agents can list all documents in a collection and then get a single document by id in a single workflow.

Example prompt: Call GET `/rest/{collection}` to list all documents in a collection, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call RestDB.io 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 apiKey tokens manually.

Example prompt: Search Jentic for 'create a new document or bulk insert', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/rest/{collection}` | Create a new document or bulk insert |
| GET | `/rest/{collection}` | List all documents in a collection |
| GET | `/rest/{collection}/{documentId}` | Get a single document by ID |
| PUT | `/rest/{collection}/{documentId}` | Replace an entire document |
| PATCH | `/rest/{collection}/{documentId}` | Update specific properties on a document |
| DELETE | `/rest/{collection}/{documentId}` | Delete a single document |
| DELETE | `/rest/{collection}/*` | Delete multiple documents by IDs or query |
| POST | `/rest/{collection}/{documentId}/{subcollection}` | Add child document to subcollection |

## Key resources

- **Collections** — CRUD operations on collections and documents
- **Media** — Upload, retrieve, and delete media files
- **Metadata** — Database and collection metadata
- **Auth** — Authentication
- **Mail** — Send emails

## 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:** 62 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 93 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 45 / 100
  - Agent Usability: 94 / 100
  - Security: 50 / 100
  - AI Discoverability: 60 / 100
- **View full report:** https://jentic.com/apis/restdb.io/restdb/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 RestDB.io REST API by hand means passing your key in the x-apikey header, resolving your database subdomain into the {dburl}.restdb.io host, and managing collection and document calls yourself. Through Jentic you install once, import RestDB.io REST API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** RestDB.io REST API puts the collection and document id in the URL path (`/rest/{collection}/{documentId}`), so a rule can pin your agent to one collection: it can read and create documents there and nothing else. You choose the operations it may call, so destructive ones like document deletion or clearing a collection are not included unless you add them.
- **Credential handling:** Your RestDB.io REST API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a new document' or 'query a collection', and Jentic returns the matching RestDB.io REST API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the RestDB.io REST API use?

The RestDB.io REST API uses an API key passed in the `x-apikey` header. 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 a new document or bulk insert with the RestDB.io REST API?

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

### What are the rate limits for the RestDB.io 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 a new document or bulk insert through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a new document or bulk insert'. Jentic returns the matching RestDB.io REST API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the RestDB.io REST API have?

The RestDB.io REST API exposes 20 endpoints covering collections, media, metadata operations.

### Can I limit what my agent is allowed to do with the RestDB.io REST API?

Yes. Because the RestDB.io REST API puts the collection and document ID in the URL path (`/rest/{collection}/{documentId}`), a rule in your self-hosted Jentic One instance can pin your agent to a single collection, letting it read and create documents there and nothing else. You decide exactly which operations the agent may call, so destructive ones such as deleting a document or clearing a collection are excluded unless you explicitly add them. Your own rules, enforced by the instance you run, determine which operations and credentials the agent can use at execution time.