Skip to main content

Documentation Index

Fetch the complete documentation index at: https://trygradient.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Connector Data

Connector data represents the knowledge base documents attached to an assessment - the data sources candidates can search during the task. Documents can be marked as signal (useful) or left as noise (distractors) to test candidate discernment.

List Available Connectors

GET /api/connectors
Returns the available connector manifests for a given assessment (based on its connector configuration).
assessmentId
string
required
The assessment to list connectors for
{
  "connectors": [
    {
      "id": "enterprise_search",
      "name": "Enterprise Search",
      "description": "Search company knowledge base",
      "icon": "search"
    }
  ]
}

List Connector Data

GET /api/assessments/:id/connector-data
{
  "connectorData": [
    {
      "id": "uuid",
      "connectorType": "enterprise_search",
      "name": "Q3 Revenue Report",
      "description": "Quarterly financial results...",
      "isSignal": true,
      "createdAt": "2025-01-15T10:00:00Z"
    }
  ]
}

Get Connector Data Item

GET /api/assessments/:id/connector-data/:docId
Returns the full connector data record including file contents.
{
  "connectorData": {
    "id": "uuid",
    "assessmentId": "uuid",
    "connectorType": "enterprise_search",
    "name": "Q3 Revenue Report",
    "description": "...",
    "dataFiles": [{ "name": "report.csv", "content": {}, "metadata": {} }],
    "isSignal": true,
    "createdAt": "2025-01-15T10:00:00Z"
  }
}

Create Connector Data

POST /api/assessments/:id/connector-data
connectorType
string
required
Connector type (e.g. enterprise_search, company_wiki, market_data, crm_data)
name
string
required
Display name for the data source
description
string
Description of the data source
dataFiles
array
Array of file objects with name, content, and optional metadata
isSignal
boolean
default:"false"
Whether this is a signal document (useful for the task)
{
  "connectorData": { "..." }
}

Upload Connector Data File

POST /api/assessments/:id/connector-data/upload
Upload a file (CSV, JSON, TXT, MD) as connector data. Content is automatically parsed. Request: multipart/form-data
file
file
required
The file to upload
connectorType
string
required
Connector type
isSignal
string
"true" or "false"
{
  "connectorData": {
    "id": "uuid",
    "name": "data.csv",
    "connectorType": "enterprise_search",
    "isSignal": false,
    "createdAt": "2025-01-15T10:00:00Z"
  }
}

Update Connector Data

PATCH /api/assessments/:id/connector-data/:docId
name
string
Updated name
description
string
Updated description
isSignal
boolean
Updated signal flag
{
  "connectorData": { "..." }
}

Delete Connector Data

DELETE /api/assessments/:id/connector-data/:docId
{
  "ok": true
}