Integration

API Per Route

Complete payload documentation for every GuidedMind API endpoint.

Detailed reference for each API endpoint with all available options, default values, and response formats.

POST /rag/search

Search your document index for relevant chunks.

Request Body

Parameter	Type	Default	Description
`query`required	`string`	—	Search query (1-1000 chars)
`options`	`object`	—	Search options (see below)

Options Object

Parameter	Type	Default	Description
`limit`	`integer`	`5`	Results to return (1-20)
`threshold`	`float`	`0.7`	Minimum similarity score (0-1)
`include_metadata`	`boolean`	`true`	Include document metadata
`search_method`	`string`	`null`	Override: dense, sparse, hybrid, graph
`context_strategy`	`string`	`null`	Override context assembly strategy

Example Request

curl -X POST "https://api.guidedmind.ai/rag/search" \
  -H "X-API-Key: rk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "What is the return policy?",
    "options": {
      "limit": 5,
      "threshold": 0.7,
      "include_metadata": true
    }
  }'

Example Response

{
  "query": "What is the return policy?",
  "answer": null,
  "results": [
    {
      "content": "Our return policy allows returns within 30 days...",
      "score": 0.92,
      "document_id": "doc_abc123",
      "document_name": "policies.pdf",
      "metadata": {
        "page": 3,
        "section": "Returns"
      }
    }
  ],
  "metadata": {
    "project_id": 42,
    "project_name": "Customer Support KB",
    "processing_time_ms": 234,
    "chunks_retrieved": 5,
    "search_method_used": "hybrid",
    "timestamp": "2026-05-20T00:00:00Z"
  }
}

Response Schema

Result Object

Field	Type	Description
`content`	string	The matching chunk text
`score`	float	Similarity score (0-1)
`document_id`	string	Source document ID
`document_name`	string	Source file name
`metadata`	object	Document metadata (if enabled)

Metadata Object

Field	Type	Description
`project_id`	integer	Project ID
`project_name`	string	Project name
`processing_time_ms`	integer	Query processing time
`chunks_retrieved`	integer	Number of results
`search_method_used`	string	Method used for search
`timestamp`	string	ISO 8601 timestamp

POST /rag/upload

Upload a document to your project (processing happens separately).

Request (Multipart Form Data)

Parameter	Type	Default	Description
`file`required	`file`	—	Document file (PDF, DOCX, TXT, MD, CSV)
`project_id`required	`string`	—	Target project ID

File Limits

Format	Max Size
PDF	50MB
DOCX	25MB
TXT/MD	10MB
CSV	25MB

Example Request

curl -X POST "https://api.guidedmind.ai/rag/upload" \
  -H "X-API-Key: rk_your_key_here" \
  -F "file=@./policies.pdf" \
  -F "project_id=proj_abc123"

Example Response

{
  "document_id": "doc_xyz789",
  "filename": "policies.pdf",
  "size_bytes": 2048576,
  "status": "uploaded",
  "message": "Document uploaded successfully. Process it to make it searchable."
}

POST /rag/upload-and-process

Upload a document and immediately start processing.

Request (Multipart Form Data)

Parameter	Type	Default	Description
`file`required	`file`	—	Document file
`project_id`required	`string`	—	Target project ID
`chunk_size`	`string`	—	Override chunk size (default: project setting)
`chunk_overlap`	`string`	—	Override chunk overlap (default: project setting)

Example Request

curl -X POST "https://api.guidedmind.ai/rag/upload-and-process" \
  -H "X-API-Key: rk_your_key_here" \
  -F "file=@./policies.pdf" \
  -F "project_id=proj_abc123" \
  -F "chunk_size=512" \
  -F "chunk_overlap=50"

Example Response

{
  "document_id": "doc_xyz789",
  "filename": "policies.pdf",
  "status": "processing",
  "chunks_created": 42,
  "message": "Document uploaded and processing started."
}

Use upload-and-process for simplicity. Use upload + separate processing when you need to batch multiple documents before indexing.

← PreviousPython (Simple)Next →MCP Overview