Syndai Docs

Read a knowledge document

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/docs/{file_id}

Syndai's view of a synced or uploaded file: its title, path, source and text (up to 2 MB). This is what an agent's citation of the file opens, so every project member can read it. Requires coding:repos:read.

Authorization

CustomerApiKey
headerAuthorizationBearer <API Key>

Customer API key sent as a bearer token

Path Parameters

coding_repository_id*string
Formatuuid
file_id*string
Formatuuid

Query Parameters

customer_id?|null

Response Body

Request fulfilled, document follows

application/json
  1. response
id*string
Formatuuid
kind*string
modified_at?|null
path*string
source*string
source_url?string|null
status*string
text*string
title*string
truncated?boolean
Defaultfalse
trust*string
Example Request
curl -X GET 'https://api.syndai.ai/api/v1/external/coding/repos/497f6eca-6276-4993-bfeb-53cbbbba6f08/knowledge/docs/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "kind": "string",  "modified_at": "2019-08-24T14:15:22Z",  "path": "string",  "source": "string",  "source_url": "string",  "status": "string",  "text": "string",  "title": "string",  "truncated": false,  "trust": "string"}
Was this page helpful?