Search | Tropicalia | Documentation

curl -X POST https://api.tropicalia.dev/v1/projects/proj_9f8b7c6d/search \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "query": "Best practices for sustainable tropical agriculture",
  "retrieval_strategy": "hybrid",
  "expand_query": false,
  "rerank": true,
  "generate_answer": true,
  "include_sources": true,
  "limit": 50
}'

{
  "retrieval_contents": [
    {
      "number": 1,
      "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f6a1d9e",
      "document": "Sustainable tropical agriculture focuses on methods that preserve soil fertility and biodiversity while maximizing crop yields.",
      "score": 0.92,
      "metadata": {
        "document_id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
        "file_name": "sustainable_farming_tropics.pdf",
        "type": "chunk",
        "chunk_index": 3,
        "date_created": "2024-01-15T09:30:00Z",
        "document_title": "Sustainable Farming Techniques in Tropical Regions",
        "chunk_size": 512,
        "page": "[12, 13]"
      },
      "rerank_score": 0.95
    }
  ],
  "completion": "Sustainable tropical agriculture involves crop diversification, soil conservation, and integrated pest management to maintain ecosystem health and productivity."
}

Perform a semantic search across project documents

Authentication

AuthorizationBearer

API key with tr_ prefix (e.g., tr_abc123)

Path parameters

projectIdstringRequired

Project ID to search within

Request

This endpoint expects an object.

querystringRequired

Search query text (max 2048 tokens)

retrieval_strategyenumOptional

Allowed values:

expand_querybooleanOptionalDefaults to false

Generate query variations to improve recall

rerankbooleanOptionalDefaults to false

Rerank results using Cohere for improved relevance

generate_answerbooleanOptionalDefaults to true

Generate a natural-language answer

include_sourcesbooleanOptionalDefaults to true

Include source documents in response. Set false to reduce payload when only the answer is needed.

limitintegerOptional1-150Defaults to 50

Maximum results to return

Response

Search results

retrieval_contentslist of objects

completionstring or null

AI-generated answer (when generate_answer is true)