Syndai Docs

Search a project's knowledge

Use a key with only read scopes. Your customer_id is in the reply to Get the calling API key.

GET
/api/v1/external/coding/repos/{coding_repository_id}/knowledge/search

Search every knowledge source of the project at once: its synced and uploaded files, each attached tool (5 s each) and its shared Google Drive. Up to 8 hits, interleaved per source, each with its passage; a source that didn't answer in time is named in slow. Requires coding:repos:read.

Authorization

CustomerApiKey
headerAuthorizationBearer <API Key>

Customer API key sent as a bearer token

Path Parameters

coding_repository_id*string
Formatuuid

Query Parameters

q*string
Length1 <= length <= 300
source?|null
customer_id?|null

Response Body

Request fulfilled, document follows

application/json
  1. response
failed?array<string>
hits*array<>
note?string|null
slow?array<string>
Example Request
curl -X GET 'https://api.syndai.ai/api/v1/external/coding/repos/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge/search?q=string'
Example Response
{  "failed": [    "string"  ],  "hits": [    {      "offset": 0,      "ref": "string",      "source": "string",      "text": "string",      "title": "string",      "url": "string"    }  ],  "note": "string",  "slow": [    "string"  ]}
Was this page helpful?