canonical: https://jentic.com/apis/newdialogue.com/newdialogue # New Dialogue REST API New Dialogue is an AI-driven conversational data insight tool that lets users chat with their operational documents, integrations, and content. The REST API exposes endpoints for sending dialogue messages, retrieving and saving responses, regenerating answers, listing message history, managing per-integration field configuration, and wiring up Zapier webhooks for outbound automation. Authentication uses an X-Authorization header carrying the user's API key. ## For AI agents Send queries to a New Dialogue knowledge base, retrieve and save AI responses, regenerate answers, and manage integration fields and Zapier webhooks. ## Scope Does not handle document ingestion, vector store management, or model fine-tuning - use for sending questions, managing responses, and wiring webhooks against an existing New Dialogue workspace only. ## Capabilities - Send a question to a New Dialogue knowledge surface and retrieve the generated reply - List historical messages, saved responses, and the current message thread - Regenerate, save, unsave, or delete a specific response by message id - List and update integration field configuration for connected integrations - Share a generated response back into a connected integration like a knowledge base or chat tool - Register and remove Zapier webhooks so external automations react to New Dialogue events - Authenticate every request with an X-Authorization header carrying the workspace API key ## Use cases ### Conversational Knowledge Base Search Internal teams query their operational knowledge by sending questions through GET /newdialogue and reading the generated reply, replacing keyword search across scattered docs with conversational retrieval. Saved responses persist via POST `/newdialogue/messages/{messageId}/save` for later reference and team reuse. Example prompt: Call GET /newdialogue with the user's question, surface the generated reply in the team's chat surface, and on a 'pin this' action POST `/newdialogue/messages/{messageId}/save` to persist the response. ### Response Regeneration Workflow When a generated answer misses the mark, users trigger POST `/newdialogue/messages/{messageId}/regenerate` to produce a fresh response without losing the conversation context. The endpoint regenerates only the specified response while preserving the rest of the thread, which keeps context relevant across iterations. Example prompt: On a 'try again' button click, POST to `/newdialogue/messages/{messageId}/regenerate` with the message id of the unsatisfactory response and replace the rendered answer with the new payload. ### Outbound Automation Through Zapier Operations teams forward New Dialogue events into Zapier zaps by registering a webhook through POST `/zapier/webhooks/newdialogue.` This makes saved responses, new messages, or specific dialogue events available to thousands of downstream apps without writing custom integration code. Example prompt: POST to `/zapier/webhooks/newdialogue` with the Zap webhook URL so saved responses are forwarded into the team's Zapier workflow automatically. ### AI Agent Knowledge Assistant An AI agent uses Jentic to discover New Dialogue endpoints and answers user questions by chaining GET /newdialogue (to query the knowledge surface) with the user's downstream tools. Confidence-rated answers feed into automation that decides whether to act, escalate, or save the response for later. Example prompt: Use Jentic to search 'ask new dialogue a question', load GET /newdialogue, execute it with the user's prompt, and on a high-confidence response POST `/newdialogue/messages/{messageId}/save` to retain it for the team. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | GET | `/newdialogue` | Send a question and receive a dialogue reply | | GET | `/newdialogue/messages` | List recent messages in the dialogue | | POST | `/newdialogue/messages/{messageId}/save` | Save a response | | POST | `/newdialogue/messages/{messageId}/regenerate` | Regenerate a response | | GET | `/newdialogue/integrations` | List connected integrations | | POST | `/newdialogue/integrations/{integrationId}/share` | Share a response into an integration | | POST | `/zapier/webhooks/newdialogue` | Register a Zapier webhook | | DELETE | `/zapier/webhooks/newdialogue` | Delete a Zapier webhook | ## Key resources - **Dialogue** — Send questions and retrieve generated dialogue responses - **Messages** — List, save, regenerate, and delete individual messages and responses - **Integrations** — Manage integration field configuration and share responses out - **Zapier** — Register and remove Zapier webhooks for outbound events ## Why Jentic - **Setup:** Wiring the New Dialogue REST API by hand means setting its X-Authorization header, targeting the ai.newdialogue.com/api/v1 host, and shaping message, integration, and webhook calls against a workspace yourself. Through Jentic you install once, import New Dialogue from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** New Dialogue puts the message and integration ids in the URL path (`/newdialogue/messages/{messageId}/save`), so a rule can pin your agent to specific messages. You choose the operations it may call, so regenerating a message or deleting a webhook is not included unless you add it. - **Credential handling:** Your New Dialogue X-Authorization 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 'ask New Dialogue a question' or 'save a response', and Jentic returns the matching New Dialogue operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **OpenAI API** — General-purpose LLM API for building custom retrieval-augmented chat - **Anthropic Messages API** — Claude messages API for direct LLM dialogue - **Zapier Natural Language Actions** — Receives New Dialogue webhook events and routes them across thousands of apps ## FAQ ### What authentication does the New Dialogue REST API use? New Dialogue uses an X-Authorization header carrying the workspace API key. Through Jentic, the API key is stored in the encrypted Jentic One instance and injected at request time so it never appears in the agent's context. ### Can I save AI responses for later reference with the New Dialogue API? Yes. POST `/newdialogue/messages/{messageId}/save` persists a specific response so it appears in the saved-messages view, and DELETE `/newdialogue/messages/{messageId}/save` removes it again. Saved responses are scoped to the workspace tied to the API key. ### How do I send a question to New Dialogue through Jentic? Search Jentic for 'ask new dialogue a question', load GET /newdialogue, and execute it with the question text. The endpoint returns the AI-generated reply along with a messageId you can pass to save, regenerate, or delete operations. ### What are the rate limits for the New Dialogue REST API? Rate limits are not declared in the spec; New Dialogue applies plan-based throttling on AI generation calls. Treat /newdialogue and `/newdialogue/messages/{messageId}/regenerate` as the heaviest endpoints and back off on 429 responses. ### Can I forward New Dialogue events into Zapier? Yes. POST `/zapier/webhooks/newdialogue` registers a Zap webhook URL and DELETE `/zapier/webhooks/newdialogue` removes it. Once registered, New Dialogue posts events to the Zap so downstream automations can react without polling. ### Is the New Dialogue REST API free? Access depends on the New Dialogue plan associated with the workspace. Free trials cover initial usage; paid plans unlock higher generation volumes. API access is included on every plan that has it enabled in the workspace settings. ### Can I limit what my agent is allowed to do with the New Dialogue REST API? Yes. Because you run your own self-hosted Jentic One instance, your rules decide which New Dialogue operations and credentials the agent may use. You can allow it to send questions with GET /newdialogue and save responses with POST `/newdialogue/messages/{messageId}/save` while withholding heavier actions like POST `/newdialogue/messages/{messageId}/regenerate` or DELETE `/zapier/webhooks/newdialogue.` Since New Dialogue carries the message and integration ids in the URL path, you can also scope the agent to specific messages and integrations rather than the whole workspace.