canonical: https://jentic.com/apis/mithi.com/mithi

# Mithi Ideolve Integration API

The Ideolve Integration API connects Mithi's Ideolve collaborative note-taking and workspace platform with third-party applications. It exposes endpoints for creating notes for a user, attaching files to notes, authenticating an integration session, and listing the user's workspaces and contacts. Integrations use a Client-Id, App-Name, and connector-api-key triple in headers to scope access to a specific user.

## For AI agents

Create notes and attach files in a user's Ideolve workspace, list contacts, and authenticate an integration session for Mithi's collaboration platform. Uses three-header API key auth.

## Scope

Does not handle email, calendar, or full document editing - use for Ideolve note creation, file attachment, workspace, and contact lookup only.

## Capabilities

- Create a note in a user's Ideolve workspace
- Attach files to an existing note
- Authenticate an integration session for a specific user
- List the workspaces accessible to a user
- List a user's Ideolve contacts

## Use cases

### Save Meeting Notes from External App

A meeting recorder or summarizer pushes its output into Ideolve as a structured note for the meeting host. The integration authenticates as the host's user, calls the note creation endpoint with the summary text, and optionally attaches the recording or transcript file. The note then appears alongside the user's other Ideolve content and is shareable with their workspace.

Example prompt: Create a note for user alice via POST `/user/alice/note` with the meeting summary, then attach transcript.txt via POST `/user/alice/note/{noteuuid}/files`

### Workspace and Contact Discovery

Before pushing content into Ideolve, an integration lists the user's workspaces and contacts to let them choose where the note should land or who to mention. The /workspaces and /contacts endpoints return identifiers that can be passed to subsequent note-creation calls or used to build picker UIs in the source application.

Example prompt: Call GET `/user/alice/workspaces` and GET `/user/alice/contacts` and present the results so the user can choose where to save the note

### Document Capture with Attachments

A document-capture pipeline scans a receipt or contract, runs OCR, and pushes the original file plus extracted text into Ideolve as a note for later review. The note creation endpoint receives the structured text and the files endpoint stores the original document so the user has both the search-friendly content and the raw evidence.

Example prompt: Create a note titled Receipt 2026-06-11 for user alice, then upload receipt.pdf via POST `/user/alice/note/{noteuuid}/files`

### Agent Workflow Integration

An agent discovered through Jentic captures task output and saves a record into Ideolve so the user can review later. Jentic stores the connector-api-key, Client-Id, and App-Name in its credential vault, so the agent only triggers the note-creation operation rather than handling secrets directly.

Example prompt: Use Jentic to find the Ideolve note creation operation and execute it with the agent's task summary as the note body

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/user/{user}/auth` | Authenticate an integration session for a user |
| POST | `/user/{user}/note` | Create a note for a user |
| POST | `/user/{user}/note/{noteuuid}/files` | Attach files to a note |
| GET | `/user/{user}/workspaces` | List the user's workspaces |
| GET | `/user/{user}/contacts` | List the user's contacts |

## Key resources

- **auth** — Authenticate an integration session for a user
- **note** — Create notes for a specific user
- **files** — Attach files to an existing note
- **workspaces** — List the workspaces a user belongs to
- **contacts** — List a user's Ideolve contacts

## Why Jentic

- **Setup:** Wiring the Ideolve Integration API by hand means setting three separate header keys (a client id, a connector API key, and an app name), authenticating each user path, and mapping note, file, and workspace calls yourself. Through Jentic you install once, import the Ideolve Integration API from the API Directory, store the keys once, and your agent calls it.
- **Permission scoping:** Ideolve puts the user and note ids in the URL path (`/user/{user}/note/{noteuuid}/files`), so a rule can pin your agent to one user's notes: it can create notes and attach files there and nothing else. You choose the operations it may call, so it can read workspaces and contacts without gaining the ability to touch other users.
- **Credential handling:** Your Ideolve header keys 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 'create an Ideolve note' or 'attach a file to a note', and Jentic returns the matching Ideolve operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Asana API** — Tasks, projects, and team collaboration
- **Trello API** — Card-based collaboration boards
- **Slack Web API** — Team messaging and channel notifications

## FAQ

### What authentication does the Ideolve Integration API use?

Ideolve uses three header-based API keys: Client-Id, App-Name, and connector-api-key. All three must be present on every request and are tied to the registered integration. Through Jentic these values are stored in the credential vault and injected at execution time.

### Can I create a note for a specific user with the Ideolve API?

Yes. Call POST `/user/{user}/note` with the user identifier in the path and the note payload in the body. The user must have authorised the integration via the auth flow first.

### What are the rate limits for the Ideolve Integration API?

Mithi applies per-integration rate limits that depend on the customer's Ideolve plan. Bulk note creation should be paced to avoid throttling. Check your Ideolve admin console for current numeric limits before running migrations.

### How do I attach a file to an Ideolve note through Jentic?

First create the note via the note creation operation and capture the returned noteuuid. Then search Jentic for attach file to ideolve note and execute against POST `/user/{user}/note/{noteuuid}/files` with the file payload.

### Does the Ideolve API let me list a user's workspaces?

Yes. GET `/user/{user}/workspaces` returns the workspaces the user belongs to so an integration can present a picker or target a specific workspace before creating notes.

### Can I limit what my agent is allowed to do with the Ideolve Integration API?

Yes. Because you run Jentic One yourself, your own rules decide which Ideolve operations and credentials the agent may use, and the user and note ids sit in the URL path (`/user/{user}/note/{noteuuid}/files`), so you can pin the agent to a single user's notes. You might allow it to create notes and attach files for that user while still reading their workspaces and contacts, without granting the ability to touch any other user. The three header keys stay with your instance and are supplied only for the calls you permit.