IRironcladapp
Search

Run Conversational Search

Changed on

Ask a natural language question and get an AI-generated response grounded in your contracts and records.

OAuth Scopes required: public.search.conversational, public.records.readRecords, public.workflows.readWorkflows

Prerequisites: Conversational Search must be enabled for your company. If you receive a 403 error, please ask your company administrator to enable the Conversational Search feature in your company settings.

post/search/conversational

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/search/conversational
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.search.conversational, public.records.readRecords, public.workflows.readWorkflows

Request body

querystring required

The natural language question to ask

modelTier'ultrafast' | 'fast' | 'standard' | 'powerful'

Controls the model used. Defaults to 'fast'. Use 'ultrafast' for the lightest/quickest model, 'standard' or 'powerful' for more capable models on complex queries.

userTimezonestring

The user's IANA timezone (e.g. "America/New_York", "Asia/Kolkata"). Used to correctly interpret relative time expressions like "last month" or "this week". If not provided, falls back to the timezone in the user's company profile, then UTC.

Example request

{
  "query": "Which contracts are expiring in the next 30 days?",
  "modelTier": "fast",
  "userTimezone": "America/New_York"
}

Response

200

resultstring required

The agent's prose response

recordsobject required

Map of record ID to record details for all records surfaced by the agent

Changes