Dashworks
WebsiteBook a DemoSign UpLogin
  • Migration Guide
  • Get Started
    • Introduction
    • Quick Start
  • Knowledge
    • Connect Apps
    • Other Sources
  • Use Cases
    • Engineering
    • Customer Support
    • Sales
    • Marketing
    • Product Management
    • Human Resources
    • Talent
    • Legal & Compliance
  • Bots
    • Custom Bots
    • Setup Bots
    • Managed Bots
  • Surfaces
    • Slackbot
    • Chrome Extension
  • Optimize
    • Improve Answers
    • Prompting
    • Instructions
    • Feedback
    • AI Model
  • Admin
    • Launch Guide
    • Announce Dashworks
    • SSO
    • SCIM
    • Analytics
    • Verified Domains
    • Schedule Training
    • Homepage
    • Chrome Extension Setup
  • API
    • Overview
    • Authentication
    • Rate Limits
    • API Reference
      • Answer API
      • Connector API
    • Zapier Integration
    • Examples
    • Pricing
  • FAQs
    • Search Permissions
    • Search Modes
    • User Roles
    • Org vs Individual
    • Real-Time vs Full Sync
    • Workflows
    • Roadmap
    • Referrals
Powered by GitBook
On this page

Was this helpful?

  1. API
  2. API Reference

Answer API

PreviousAPI ReferenceNextConnector API

Last updated 2 months ago

Was this helpful?

Get Answer from Dashworks Bot

post
Header parameters
authorizationstringRequired

Authorization header in the format: 'Bearer {api_key}'

Body
messagestringRequired

The message (e.g., a question or prompt) that you want a response to

bot_idstringRequired

The ID of the Dashworks Bot to interact with. You can find this by going to Dashworks > Bots, clicking on an existing Bot, and using the 'Copy Bot ID' button on the top right

inline_sourcesbooleanOptional

When true (default), sources will be cited inline in markdown formatting within the answer text. When false, the answer will not contain inline citations, but the sources used will still be returned in the sources field.

Default: true
streambooleanOptional

When true, the response is streamed as Server-Sent Events (SSE). Otherwise, the entire answer is returned in a single response. Default is false.

Default: false
Responses
200
Successful Response
application/json
401
Unauthorized
application/json
402
Payment Required
application/json
404
Not found
422
Validation Error
application/json
429
Rate Limit Exceeded
application/json
post
POST /v1/answer HTTP/1.1
Host: api.dashworks.ai
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "message": "text",
  "bot_id": "text",
  "inline_sources": true,
  "stream": true
}
{
  "answer": "text",
  "sources": [
    {
      "url": "text",
      "app_name": "text",
      "author": {
        "name": "text",
        "email": "text",
        "photo": "text"
      },
      "title": "text",
      "snippet": "text",
      "modified_time": 1
    }
  ],
  "answer_found": true
}