API Reference

Promptly

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Models

List available models

client.promptly.models.list(RequestOptionsoptions?): ModelListResponse { id, codingIndex, contextLength, 8 more }

GET/api/promptly/models

Get a model

client.promptly.models.retrieve(stringmodelID, RequestOptionsoptions?): Model { id, codingIndex, contextLength, 8 more }

GET/api/promptly/models/{modelId}

ModelsExpand Collapse

Model { id, codingIndex, contextLength, 8 more }

id?: string

formatuuid

codingIndex?: number

Coding benchmark score

contextLength?: number

Maximum context window size

intelligenceIndex?: number

Intelligence benchmark score

minimum0

maximum100

name?: string

openRouterId?: string

Model identifier for OpenRouter

outputSpeed?: number

Tokens per second

powerTier?: number

Power tier (1 = most powerful)

minimum1

maximum5

provider?: string

Model provider (anthropic, openai, google, etc.)

supportsInternetSearch?: boolean

supportsToolCalling?: boolean