Skip to main content
GET
/
contexts
/
semantic-search
Semantic search contexts
curl --request GET \
  --url https://apigcp.trynia.ai/v2/contexts/semantic-search \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "organization_id": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "content": "<string>",
      "tags": [
        "<string>"
      ],
      "agent_source": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metadata": {},
      "nia_references": {
        "indexed_repositories": [
          "<string>"
        ],
        "indexed_documentation": [
          "<string>"
        ],
        "queried_repositories": [
          "<string>"
        ],
        "queried_documentation": [
          "<string>"
        ],
        "web_searches": [
          "<string>"
        ],
        "deep_research_queries": [
          "<string>"
        ]
      },
      "edited_files": [
        {
          "file_path": "<string>",
          "operation": "created",
          "lines_added": 123,
          "lines_removed": 123,
          "language": "<string>"
        }
      ],
      "memory_type": "scratchpad",
      "expires_at": "2023-11-07T05:31:56Z",
      "lineage": {
        "created_at": "2023-11-07T05:31:56Z",
        "source_ids": [
          "<string>"
        ],
        "confidence": 0.5,
        "derived_from": [
          "<string>"
        ],
        "tool_calls": [
          "<string>"
        ],
        "model_version": "<string>"
      },
      "relevance_score": 123,
      "match_metadata": {
        "search_type": "hybrid",
        "vector_score": 123,
        "rank": 123
      },
      "match_highlights": [
        "<string>"
      ],
      "files_edited": [
        "<string>"
      ],
      "workspace_name": "<string>"
    }
  ],
  "search_query": "<string>",
  "search_metadata": {
    "search_type": "<string>",
    "total_results": 123,
    "vector_matches": 123,
    "mongodb_matches": 123
  },
  "suggestions": {
    "related_tags": [
      "<string>"
    ],
    "workspaces": [
      "<string>"
    ],
    "tips": [
      "<string>"
    ]
  }
}

Authorizations

​
Authorization
string
header
required

API key must be provided in the Authorization header

Query Parameters

​
q
string
required

Search query

Minimum string length: 1
​
limit
integer
default:20

Maximum number of results

Required range: 1 <= x <= 100
​
include_highlights
boolean
default:true

Include match highlights in results

​
workspace_filter
string

Filter by specific workspace name

Response

Semantic search completed successfully

​
results
object[]
​
search_query
string
​
search_metadata
object
​
suggestions
object