Skip to main content
POST
/
responses
curl -X POST https://app.usehindsight.com/api/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "role": "user",
        "content": "What security objections have we encountered with Enterprise customers?"
      }
    ],
    "stream": false
  }'

{
  "message": {
    "role": "assistant",
    "content": "<string>",
    "citations": [
      {
        "document_id": "<string>",
        "document_name": "<string>",
        "deal_id": "<string>",
        "deal_name": "<string>",
        "url": "https://app.usehindsight.com/deals/deal_123/documents/viewer/doc_abc123",
        "excerpt": "<string>"
      }
    ]
  },
  "tool_calls": [
    "search_across_deals",
    "search_deal_documents"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.usehindsight.com/llms.txt

Use this file to discover all available pages before exploring further.

POST https://app.usehindsight.com/api/v1/responses
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Request body:
{
  "messages": [
    { "role": "user | assistant | system", "content": "string" }
  ],
  "stream": false
}

200 Response:
{
  "message": {
    "role": "assistant",
    "content": "AI-generated response with inline citations",
    "citations": [
      {
        "document_id": "string",
        "document_name": "string",
        "deal_id": "string | null",
        "deal_name": "string | null",
        "url": "https://app.usehindsight.com/deals/deal_123/documents/viewer/doc_abc123",
        "excerpt": "string"
      }
    ]
  },
  "tool_calls": ["search_across_deals", "search_deal_documents"]
}

Rate limits: 10 req/min (Essentials), 60 req/min (Growth), 300 req/min (Enterprise)
           10,000/mo (Essentials), 30,000/mo (Growth), 100,000/mo (Enterprise)

curl -X POST https://app.usehindsight.com/api/v1/responses \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      {
        "role": "user",
        "content": "What security objections have we encountered with Enterprise customers?"
      }
    ],
    "stream": false
  }'

Authorizations

​
Authorization
string
header
required

API key from Hindsight dashboard

Body

application/json
​
messages
object[]
required

The conversation messages

Minimum array length: 1
​
stream
boolean
default:false

Whether to stream the response using Server-Sent Events

Response

Successful response

​
message
object
​
tool_calls
string[]

The internal tools that were called to generate the response

Example:
[
  "search_across_deals",
  "search_deal_documents"
]