New Dialogue REST API
✓ Official Vendor SpecAI/MLLanguage ModelsapiKey17 EndpointsREST
For Agents
Send queries to a New Dialogue knowledge base, retrieve and save AI responses, regenerate answers, and manage integration fields and Zapier webhooks.
Use for: Send a question to my New Dialogue workspace, Retrieve message history from New Dialogue, Save a useful AI response for later reference, Regenerate an answer that was unsatisfactory
Not supported: 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.
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.
Install Jentic One Beta
Connect the New Dialogue REST API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the New Dialogue REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with New Dialogue REST API.
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
Patterns agents use New Dialogue REST API for, with concrete tasks.
★ 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.
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.
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.
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.
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
17 endpoints — new dialogue is an ai-driven conversational data insight tool that lets users chat with their operational documents, integrations, and content.
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
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
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
New Dialogue X-Authorization API keys are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw API keys never enter the agent's context.
Intent-based discovery
Agents search by intent (e.g., 'ask new dialogue a question') and Jentic returns matching New Dialogue operations with their input schemas, so the agent can call the right endpoint without browsing docs.
Time to first call
Direct New Dialogue integration: 1-2 days for auth, message lifecycle, and Zapier webhook wiring. Through Jentic: under 1 hour — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using New Dialogue REST API through Jentic.
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 MAXsystem vault 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.
GET STARTED