API Reference

Promptly

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Sources

List all sources

client.promptly.sources.list(SourceListParams { organizationId } query, RequestOptionsoptions?): SourceListResponse { id, config, name, 14 more }

GET/api/promptly/sources

Create a source

client.promptly.sources.create(SourceCreateParams { config, name, organizationId, 6 more } body, RequestOptionsoptions?): Source { id, config, name, 14 more }

POST/api/promptly/sources

Get a source

client.promptly.sources.retrieve(stringsourceID, RequestOptionsoptions?): Source { id, config, name, 14 more }

GET/api/promptly/sources/{sourceId}

Update a source

client.promptly.sources.update(stringsourceID, SourceUpdateParams { authConfig, authType, config, 3 more } body, RequestOptionsoptions?): Source { id, config, name, 14 more }

PATCH/api/promptly/sources/{sourceId}

Delete a source

client.promptly.sources.delete(stringsourceID, RequestOptionsoptions?): void

DELETE/api/promptly/sources/{sourceId}

Test a source connection

client.promptly.sources.test(stringsourceID, RequestOptionsoptions?): SourceTestResponse { message, success, tools }

POST/api/promptly/sources/{sourceId}/test

ModelsExpand Collapse

Source { id, config, name, 14 more }

id: string

formatuuid

config: Config { args, baseUrl, command, 3 more }

Source-specific configuration

args?: Array<string>

Command arguments

baseUrl?: string

Base URL for API sources

formaturi

command?: string

Command to run for stdio transport

env?: Record<string, string>

Environment variables

transport?: "stdio" | "http" | "websocket"

MCP transport type

Accepts one of the following:

"stdio"

"http"

"websocket"

url?: string

URL for http/websocket transport

formaturi

name: string

type: "mcp" | "api" | "local"

Source connection type

Accepts one of the following:

"mcp"

"api"

"local"

authConfig?: AuthConfig { headerName, prefix, provider }

Authentication configuration

headerName?: string

prefix?: string

provider?: string

authType?: "none" | "oauth" | "bearer" | 5 more

Accepts one of the following:

"none"

"oauth"

"bearer"

"basic"

"header"

"query"

"api_key"

"composio"

composioConnected?: boolean

Whether Composio OAuth is completed

composioToolkit?: string

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

createdAt?: string

formatdate-time

description?: string

iconUrl?: string

formaturi

isActive?: boolean

Whether the source is connected and ready

lastConnectedAt?: string

formatdate-time

organizationId?: string

formatuuid

slug?: string

URL-friendly identifier

tools?: Array<Tool { description, inputSchema, name } >

Available tools from this source

description?: string

inputSchema?: unknown

JSON Schema for tool parameters

name?: string

updatedAt?: string

formatdate-time

Tool { description, inputSchema, name }

description?: string

inputSchema?: unknown

JSON Schema for tool parameters

name?: string