Ask a question and get an answer

Submit a natural language question to the system and receive an AI-generated answer based on your ingested content

POST /search

Try it

Ask a question and get an answer

cURL

curl --request POST \
  --url https://sdk.senso.ai/api/v1/search \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "query": "<string>",
  "max_results": 123,
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "topic_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

200

{
  "query": "<string>",
  "answer": "<string>",
  "results": [
    {
      "content_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "chunk_index": 123,
      "chunk_text": "<string>",
      "score": 123,
      "title": "<string>",
      "vector_id": "<string>"
    }
  ],
  "total_results": 123,
  "max_results": 123,
  "processing_time_ms": 123
}

Authorizations

X-API-Key · string · header · required

API key authorization

Body

application/json

query · string · required

The natural language question to search for

max_results · integer

Maximum number of results to return (default is 5)

org_id · string<uuid>

Organization ID (defaults to user's current org)

category_id · string<uuid>

Optional filter for specific category

topic_id · string<uuid>

Optional filter for specific topic

Response

200

application/json

Search completed successfully with an answer

query · string

The original search query

answer · string

The AI-generated answer to the query

results · object[]

Source chunks used to generate the answer

Show child attributes

results. content_id · string<uuid>

The unique identifier of the source content

results. version_id · string<uuid>

The version identifier of the source content

results. chunk_index · integer

The index of this chunk within the content

results. chunk_text · string

The relevant excerpt from the source content

results. score · number<float>

The relevance score of this chunk

results. title · string

The title of the source content

results. vector_id · string

The vector ID for debugging purposes

total_results · integer

Total number of results found

max_results · integer

Maximum number of results requested

processing_time_ms · integer

Processing time in milliseconds