Skip to main content
POST
/
v1
/
search
Search Documents
curl --request POST \
  --url https://api.clarm.com/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "chat_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": 0,
  "use_agentic_search": false,
  "recency_bias_multiplier": 1,
  "model": "<string>"
}
'
{
  "query": "<string>",
  "chat_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "answer": "<string>",
  "citations": [
    {
      "document_id": "<string>",
      "chunk_ind": 123,
      "semantic_identifier": "<string>",
      "blurb": "<string>",
      "source_type": "ingestion_api",
      "boost": 123,
      "hidden": true,
      "metadata": {},
      "match_highlights": [
        "<string>"
      ],
      "link": "<string>",
      "score": 123,
      "is_relevant": true,
      "relevance_explanation": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "primary_owners": [
        "<string>"
      ],
      "secondary_owners": [
        "<string>"
      ],
      "is_internet": false
    }
  ]
}
Invoke our core agentic search functionality with your desired query. Clarm retrieves relevant documents and uses an inference layer to synthesise a natural language response to the query.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Public API search request model

​
query
string
required
​
chat_session_id
string<uuid> | null
​
agent_id
integer | null
default:0
​
use_agentic_search
boolean | null
default:false
​
recency_bias_multiplier
number | null
default:1
​
model
string | null

OpenAI model identifier e.g. o4-mini, gpt-4.1

Response

Successful Response

Public API search response model

​
query
string
required
​
chat_session_id
string<uuid> | null
​
answer
string | null
​
citations
SearchDoc · object[]