Skip to content
Last updated

🔨 In Development — This section is still being developed and may change.
Represents an external service integration that can be used by Freddy AI assistants.

Properties

id string

Unique identifier for the connector. Format: conn_ followed by alphanumeric characters.

name string

Human-readable name for the connector (e.g., "GitHub", "Slack", "ClickUp").

description string

Detailed description of what the connector does and its capabilities.

category string

Service category. Values: communication, project_management, development, business, cloud, marketing.

serviceType string

Specific service identifier (e.g., "github", "slack", "clickup").

connectorType string

Type of connector. Values: personal, assistant, mcp.

capabilities object

Technical capabilities and supported operations.

Show capabilities

authentication array of strings

Supported authentication methods. Values: oauth2, api_key, service_account, webhook.

operations array of strings

Available operations. Example: ["read", "write", "create", "delete", "search"].

dataTypes array of strings

Supported data types. Example: ["issues", "messages", "tasks", "files", "users"].

rateLimits object optional

API rate limiting information.

Show rate limits

requestsPerMinute integer

Maximum requests per minute.

requestsPerHour integer

Maximum requests per hour.

requestsPerDay integer

Maximum requests per day.

configuration object

Required configuration parameters for setup.

Show configuration

requiredFields array of strings

Mandatory configuration fields. Example: ["apiKey", "webhookUrl"].

optionalFields array of strings

Optional configuration fields. Example: ["timeout", "retryCount"].

validationRules object optional

Field validation rules.

pricing object optional

Pricing information for connector usage.

Show pricing

setupCost number optional

One-time setup cost.

monthlyCost number optional

Monthly subscription cost.

usageCost number optional

Cost per API call or operation.

status string

Connector availability status. Values: active, beta, deprecated, maintenance.

isPreview boolean

Whether this connector is in preview/beta status.

createdAt integer

Unix timestamp (seconds) when the connector was created.

updatedAt integer

Unix timestamp (seconds) when the connector was last updated.


Returns

A ApiResponse object containing the API response data.

Example Connectors

{
  "id": "conn_github",
  "name": "GitHub",
  "description": "Code repository and collaboration platform integration for development workflows.",
  "category": "development",
  "serviceType": "github",
  "connectorType": "personal",
  "capabilities": {
    "authentication": ["oauth2", "api_key"],
    "operations": ["read", "write", "create", "search"],
    "dataTypes": ["repositories", "issues", "pull_requests", "commits", "users"],
    "rateLimits": {
      "requestsPerHour": 5000,
      "requestsPerDay": 100000
    }
  },
  "configuration": {
    "requiredFields": ["accessToken"],
    "optionalFields": ["organization", "repositories"],
    "validationRules": {
      "accessToken": "Valid GitHub personal access token with appropriate scopes"
    }
  },
  "pricing": {
    "setupCost": 0,
    "monthlyCost": 0,
    "usageCost": 0.0001
  },
  "status": "active",
  "isPreview": false,
  "createdAt": 1728057600,
  "updatedAt": 1728057600
}