Skip to content
0ct
Get started
API Reference
Promptly

Sources

List all sources
GET/api/promptly/sources
Create a source
POST/api/promptly/sources
Get a source
GET/api/promptly/sources/{sourceId}
Update a source
PATCH/api/promptly/sources/{sourceId}
Delete a source
DELETE/api/promptly/sources/{sourceId}
Test a source connection
POST/api/promptly/sources/{sourceId}/test
ModelsExpand Collapse
Source = object { id, config, name, 14 more }
id: string
formatuuid
config: object { args, baseUrl, command, 3 more }

Source-specific configuration

args: optional array of string

Command arguments

baseUrl: optional string

Base URL for API sources

formaturi
command: optional string

Command to run for stdio transport

env: optional map[string]

Environment variables

transport: optional "stdio" or "http" or "websocket"

MCP transport type

Accepts one of the following:
"stdio"
"http"
"websocket"
url: optional string

URL for http/websocket transport

formaturi
name: string
type: "mcp" or "api" or "local"

Source connection type

Accepts one of the following:
"mcp"
"api"
"local"
authConfig: optional object { headerName, prefix, provider }

Authentication configuration

headerName: optional string
prefix: optional string
provider: optional string
authType: optional "none" or "oauth" or "bearer" or 5 more
Accepts one of the following:
"none"
"oauth"
"bearer"
"basic"
"header"
"query"
"api_key"
"composio"
composioConnected: optional boolean

Whether Composio OAuth is completed

composioToolkit: optional string

Composio toolkit name (e.g., 'todoist', 'github')

createdAt: optional string
formatdate-time
description: optional string
iconUrl: optional string
formaturi
isActive: optional boolean

Whether the source is connected and ready

lastConnectedAt: optional string
formatdate-time
organizationId: optional string
formatuuid
slug: optional string

URL-friendly identifier

tools: optional array of Tool { description, inputSchema, name }

Available tools from this source

description: optional string
inputSchema: optional unknown

JSON Schema for tool parameters

name: optional string
updatedAt: optional string
formatdate-time
Tool = object { description, inputSchema, name }
description: optional string
inputSchema: optional unknown

JSON Schema for tool parameters

name: optional string