cursor-api

说明

获取key

配置说明

环境变量

Token文件格式(已弃用)

# 这里的#表示这行在下次读取要删除
token1,checksum1
token2,checksum2

模型列表

接口说明

基础对话

请求格式

{
 "model": string,
 "messages": [
 {
 "role": "system" | "user" | "assistant", // "system" 也可以是 "developer"
 "content": string | [
 {
 "type": "text" | "image_url",
 "text": string,
 "image_url": {
 "url": string
 }
 }
 ]
 }
 ],
 "stream": bool,
 "stream_options": {
 "include_usage": bool
 }
}

响应格式

{
 "id": string,
 "object": "chat.completion",
 "created": number,
 "model": string,
 "choices": [
 {
 "index": number,
 "message": {
 "role": "assistant",
 "content": string
 },
 "finish_reason": "stop" | "length"
 }
 ],
 "usage": {
 "prompt_tokens": 0,
 "completion_tokens": 0,
 "total_tokens": 0
 }
}

data: {"id":string,"object":"chat.completion.chunk","created":number,"model":string,"choices":[{"index":number,"delta":{"role":"assistant","content":string},"finish_reason":null}]}
data: {"id":string,"object":"chat.completion.chunk","created":number,"model":string,"choices":[{"index":number,"delta":{"content":string},"finish_reason":null}]}
data: {"id":string,"object":"chat.completion.chunk","created":number,"model":string,"choices":[{"index":number,"delta":{},"finish_reason":"stop"}]}
data: [DONE]

获取模型列表

查询参数

{
 "is_nightly": bool, // 是否包含 nightly 版本模型,默认 false
 "include_long_context_models": bool, // 是否包含长上下文模型,默认 false 
 "exclude_max_named_models": bool, // 是否排除 max 命名的模型,默认 true
 "additional_model_names": [string] // 额外包含的模型名称列表,默认空数组
}

响应格式

{
 object: "list",
 data: [
 {
 id: string,
 display_name: string,
 created: number,
 created_at: string,
 object: "model",
 type: "model", 
 owned_by: string,
 supports_thinking: bool,
 supports_images: bool,
 supports_max_mode: bool,
 supports_non_max_mode: bool
 }
 ]
}

更新模型列表说明

Token管理接口

获取Token信息

{
 status: "success",
 tokens: [
 [
 number,
 string,
 {
 primary_token: string,
 secondary_token?: string,
 checksum: {
 first: string,
 second: string,
 },
 client_key?: string,
 config_version?: string,
 session_id?: string,
 proxy?: string,
 timezone?: string,
 gcpp_host?: "Asia" | "EU" | "US",
 user?: {
 user_id: int32,
 email?: string,
 first_name?: string,
 last_name?: string,
 workos_id?: string,
 team_id?: number,
 created_at?: string,
 is_enterprise_user: bool,
 is_on_new_pricing: bool,
 privacy_mode_info: {
 privacy_mode: "unspecified" | "no_storage" | "no_training" | "usage_data_training_allowed" | "usage_codebase_training_allowed",
 is_enforced_by_team?: bool
 }
 },
 status: {
 enabled: bool
 },
 usage?: {
 billing_cycle_start: string,
 billing_cycle_end: string,
 membership_type: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 limit_type: "user" | "team",
 is_unlimited: bool,
 individual_usage: {
 plan?: {
 enabled: bool,
 used: int32,
 limit: int32,
 remaining: int32,
 breakdown: {
 included: int32,
 bonus: int32,
 total: int32
 }
 },
 on_demand?: {
 enabled: bool,
 used: int32,
 limit?: int32,
 remaining?: int32
 }
 },
 team_usage: {
 plan?: {
 enabled: bool,
 used: int32,
 limit: int32,
 remaining: int32,
 breakdown: {
 included: int32,
 bonus: int32,
 total: int32
 }
 },
 on_demand?: {
 enabled: bool,
 used: int32,
 limit?: int32,
 remaining?: int32
 }
 },
 },
 stripe?: {
 membership_type: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 payment_id?: string,
 days_remaining_on_trial: int32,
 subscription_status?: "trialing" | "active" | "incomplete" | "incomplete_expired" | "past_due" | "canceled" | "unpaid" | "paused",
 verified_student: bool,
 trial_eligible: bool,
 trial_length_days: int32,
 is_on_student_plan: bool,
 is_on_billable_auto: bool,
 customer_balance?: double,
 trial_was_cancelled: bool,
 is_team_member: bool,
 team_membership_type?: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 individual_membership_type?: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise"
 },
 sessions?: [
 {
 session_id: string,
 type: "unspecified" | "web" | "client" | "bugbot" | "background_agent",
 created_at: string,
 expires_at: string
 }
 ]
 }
 ]
 ],
 tokens_count: uint64
}

设置Token信息

[
 [
 string,
 {
 primary_token: string,
 secondary_token?: string,
 checksum: {
 first: string,
 second: string,
 },
 client_key?: string,
 config_version?: string,
 session_id?: string,
 proxy?: string,
 timezone?: string,
 gcpp_host?: "Asia" | "EU" | "US",
 user?: {
 user_id: int32,
 email?: string,
 first_name?: string,
 last_name?: string,
 workos_id?: string,
 team_id?: number,
 created_at?: string,
 is_enterprise_user: bool,
 is_on_new_pricing: bool,
 privacy_mode_info: {
 privacy_mode: "unspecified" | "no_storage" | "no_training" | "usage_data_training_allowed" | "usage_codebase_training_allowed",
 is_enforced_by_team?: bool
 }
 },
 status: {
 enabled: bool
 },
 usage?: {
 billing_cycle_start: string,
 billing_cycle_end: string,
 membership_type: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 limit_type: "user" | "team",
 is_unlimited: bool,
 individual_usage: {
 plan?: {
 enabled: bool,
 used: int32,
 limit: int32,
 remaining: int32,
 breakdown: {
 included: int32,
 bonus: int32,
 total: int32
 }
 },
 on_demand?: {
 enabled: bool,
 used: int32,
 limit?: int32,
 remaining?: int32
 }
 },
 team_usage: {
 plan?: {
 enabled: bool,
 used: int32,
 limit: int32,
 remaining: int32,
 breakdown: {
 included: int32,
 bonus: int32,
 total: int32
 }
 },
 on_demand?: {
 enabled: bool,
 used: int32,
 limit?: int32,
 remaining?: int32
 }
 },
 },
 stripe?: {
 membership_type: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 payment_id?: string,
 days_remaining_on_trial: int32,
 subscription_status?: "trialing" | "active" | "incomplete" | "incomplete_expired" | "past_due" | "canceled" | "unpaid" | "paused",
 verified_student: bool,
 trial_eligible: bool,
 trial_length_days: int32,
 is_on_student_plan: bool,
 is_on_billable_auto: bool,
 customer_balance?: double,
 trial_was_cancelled: bool,
 is_team_member: bool,
 team_membership_type?: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 individual_membership_type?: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise"
 }
 }
 ]
]

{
 status: "success",
 tokens_count: uint64,
 message: "Token files have been updated and reloaded"
}

添加Token

{
 tokens: [
 {
 alias?: string, // 可选,无则自动生成
 token: string,
 checksum?: string, // 可选,无则自动生成
 client_key?: string, // 可选,无则自动生成
 session_id?: string, // 可选
 config_version?: string, // 可选
 proxy?: string, // 可选
 timezone?: string, // 可选
 gcpp_host?: string // 可选
 }
 ],
 enabled: bool
}

{
 status: "success",
 tokens_count: uint64,
 message: string // "New tokens have been added and reloaded" 或 "No new tokens were added"
}

删除Token

{
 "aliases": [string], // 要删除的token列表
 "include_failed_tokens": bool // 默认为false
}

{
 "status": "success",
 "failed_tokens": [string] // 可选,根据include_failed_tokens返回,表示未找到的token列表
}

设置Tokens标签(已弃用)

{
 "tokens": [string],
 "tags": {
 string: null | string // 键可以为 timezone: 时区标识符 或 proxy: 代理名称
 }
}

{
 "status": "success",
 "message": string // "标签更新成功"
}

更新令牌Profile

[
 string // aliases
]

{
 "status": "success",
 "message": "已更新{}个令牌配置, {}个令牌更新失败"
}

更新令牌Config Version

[
 string // aliases
]

{
 "status": "success",
 "message": "已更新{}个令牌配置版本, {}个令牌更新失败"
}

刷新令牌

[
 string // aliases
]

{
 "status": "success",
 "message": "已刷新{}个令牌, {}个令牌刷新失败"
}

设置令牌状态

{
 "aliases": [string],
 "enabled": bool
}

{
 "status": "success",
 "message": "已设置{}个令牌状态, {}个令牌设置失败"
}

设置令牌别名

{
 "{old_alias}": "{new_alias}"
}

{
 "status": "success",
 "message": "已设置{}个令牌别名, {}个令牌设置失败"
}

设置Tokens代理

{
 "aliases": [string],
 "proxy": string // 可选,代理地址,null表示清除代理
}

{
 "status": "success",
 "message": "已设置{}个令牌代理, {}个令牌设置失败"
}

设置Tokens时区

{
 "aliases": [string],
 "timezone": string // 可选,时区标识符(如"Asia/Shanghai"),null表示清除时区
}

{
 "status": "success",
 "message": "已设置{}个令牌时区, {}个令牌设置失败"
}

合并Tokens附带数据

{
 "{alias}": { // 以下至少其一存在,否则会失败
 "primary_token": string, // 可选
 "secondary_token": string, // 可选
 "checksum": { // 可选
 "first": string,
 "second": string,
 },
 "client_key": string, // 可选
 "config_version": string, // 可选
 "session_id": string, // 可选
 "proxy": string, // 可选
 "timezone": string, // 可选
 "gcpp_host": object, // 可选
 }
}

{
 "status": "success",
 "message": "已合并{}个令牌, {}个令牌合并失败"
}

构建API Key

{
 "token": string, // 格式: JWT
 "checksum": {
 "first": string, // 格式: 长度为64的Hex编码字符串
 "second": string, // 格式: 长度为64的Hex编码字符串
 },
 "client_key": string, // 格式: 长度为64的Hex编码字符串
 "config_version": string, // 格式: UUID
 "session_id": string, // 格式: UUID
 "proxy_name": string, // 可选,指定代理
 "timezone": string, // 可选,指定时区
 "gcpp_host": string, // 可选,代码补全区域
 "disable_vision": bool, // 可选,禁用图片处理能力
 "enable_slow_pool": bool, // 可选,启用慢速池
 "include_web_references": bool,
 "usage_check_models": { // 可选,使用量检查模型配置
 "type": "default" | "disabled" | "all" | "custom",
 "model_ids": string // 当type为custom时生效,以逗号分隔的模型ID列表
 }
}

{
 "keys": [string] // 成功时返回生成的key
}

{
 "error": string // 错误信息
}

代理管理接口

获取代理配置信息

{
 "status": "success",
 "proxies": {
 "proxies": {
 "proxy_name": "non" | "sys" | "http://proxy-url",
 },
 "general": string // 当前使用的通用代理名称
 },
 "proxies_count": number,
 "general_proxy": string,
 "message": string // 可选
}

设置代理配置

{
 "proxies": {
 "{proxy_name}": "non" | "sys" | "http://proxy-url"
 },
 "general": string // 要设置的通用代理名称
}

{
 "status": "success",
 "proxies_count": number,
 "message": "代理配置已更新"
}

添加代理

{
 "proxies": {
 "{proxy_name}": "non" | "sys" | "http://proxy-url"
 }
}

{
 "status": "success",
 "proxies_count": number,
 "message": string // "已添加 X 个新代理" 或 "没有添加新代理"
}

删除代理

{
 "names": [string], // 要删除的代理名称列表
 "expectation": "simple" | "updated_proxies" | "failed_names" | "detailed" // 默认为simple
}

{
 "status": "success",
 "updated_proxies": { // 可选,根据expectation返回
 "proxies": {
 "proxy_name": "non" | "sys" | "http://proxy-url"
 },
 "general": string
 },
 "failed_names": [string] // 可选,根据expectation返回,表示未找到的代理名称列表
}

设置通用代理

{
 "name": string // 要设置为通用代理的代理名称
}

{
 "status": "success",
 "message": "通用代理已设置"
}

代理类型说明

注意事项

错误格式

{
 "status": "error",
 "code": number, // 可选
 "error": string, // 可选,错误详细信息
 "message": string // 错误提示信息
}

配置管理接口

获取配置

更新配置

更新配置

日志管理接口

获取日志接口

获取日志数据

{
 "query": {
 // 分页与排序控制
 "limit": number, // 可选,返回记录数量限制
 "offset": number, // 可选,起始位置偏移量
 "reverse": bool, // 可选,反向排序,默认false(从旧到新),true时从新到旧
 // 时间范围过滤
 "from_date": string, // 可选,开始日期时间,RFC3339格式
 "to_date": string, // 可选,结束日期时间,RFC3339格式
 // 用户标识过滤
 "user_id": string, // 可选,按用户ID精确匹配
 "email": string, // 可选,按用户邮箱过滤(支持部分匹配)
 "membership_type": string, // 可选,按会员类型过滤 ("free"/"free_trial"/"pro"/"pro_plus"/"ultra"/"enterprise")
 // 核心业务过滤
 "status": string, // 可选,按状态过滤 ("pending"/"success"/"failure")
 "model": string, // 可选,按模型名称过滤(支持部分匹配)
 "include_models": [string], // 可选,包含特定模型
 "exclude_models": [string], // 可选,排除特定模型
 // 请求特征过滤
 "stream": bool, // 可选,是否为流式请求
 "has_chain": bool, // 可选,是否包含对话链
 "has_usage": bool, // 可选,是否有usage信息
 // 错误相关过滤
 "has_error": bool, // 可选,是否包含错误
 "error": string, // 可选,按错误过滤(支持部分匹配)
 // 性能指标过滤
 "min_total_time": number, // 可选,最小总耗时(秒)
 "max_total_time": number, // 可选,最大总耗时(秒)
 "min_tokens": number, // 可选,最小token数(input + output)
 "max_tokens": number // 可选,最大token数
 }
}

{
 status: "success",
 total: uint64,
 active?: uint64,
 error?: uint64,
 logs: [
 {
 id: uint64,
 timestamp: string,
 model: string,
 token_info: {
 key: string,
 usage?: {
 billing_cycle_start: string,
 billing_cycle_end: string,
 membership_type: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 limit_type: "user" | "team",
 is_unlimited: bool,
 individual_usage: {
 plan?: {
 enabled: bool,
 used: int32,
 limit: int32,
 remaining: int32,
 breakdown: {
 included: int32,
 bonus: int32,
 total: int32
 }
 },
 on_demand?: {
 enabled: bool,
 used: int32,
 limit?: int32,
 remaining?: int32
 }
 },
 team_usage: {
 plan?: {
 enabled: bool,
 used: int32,
 limit: int32,
 remaining: int32,
 breakdown: {
 included: int32,
 bonus: int32,
 total: int32
 }
 },
 on_demand?: {
 enabled: bool,
 used: int32,
 limit?: int32,
 remaining?: int32
 }
 },
 },
 stripe?: {
 membership_type: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 payment_id?: string,
 days_remaining_on_trial: int32,
 subscription_status?: "trialing" | "active" | "incomplete" | "incomplete_expired" | "past_due" | "canceled" | "unpaid" | "paused",
 verified_student: bool,
 trial_eligible: bool,
 trial_length_days: int32,
 is_on_student_plan: bool,
 is_on_billable_auto: bool,
 customer_balance?: double,
 trial_was_cancelled: bool,
 is_team_member: bool,
 team_membership_type?: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 individual_membership_type?: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise"
 }
 },
 chain: {
 delays?: [
 string,
 [
 number, // chars count
 number // time
 ]
 ],
 usage?: {
 input: int32,
 output: int32,
 cache_write: int32,
 cache_read: int32,
 cents: float
 }
 },
 timing: {
 total: double
 },
 stream: bool,
 status: "pending" | "success" | "failure",
 error?: string | {
 error:string,
 details:string
 }
 }
 ],
 timestamp: string
}

获取日志令牌

[
 string
]

{
 status: "success",
 tokens: {
 {key}: {
 primary_token: string,
 secondary_token?: string,
 checksum: {
 first: string,
 second: string,
 },
 client_key?: string,
 config_version?: string,
 session_id?: string,
 proxy?: string,
 timezone?: string,
 gcpp_host?: "Asia" | "EU" | "US",
 user?: {
 user_id: int32,
 email?: string,
 first_name?: string,
 last_name?: string,
 workos_id?: string,
 team_id?: number,
 created_at?: string,
 is_enterprise_user: bool,
 is_on_new_pricing: bool,
 privacy_mode_info: {
 privacy_mode: "unspecified" | "no_storage" | "no_training" | "usage_data_training_allowed" | "usage_codebase_training_allowed",
 is_enforced_by_team?: bool
 }
 }
 }
 },
 total: uint64,
 timestamp: string
}

静态资源接口

环境变量示例

配置文件示例

文档

许可

健康检查接口

响应结构

{
 "status": "success",
 "service": {
 "name": "cursor-api",
 "version": "1.0.0",
 "is_debug": false,
 "build": {
 "version": 1,
 "timestamp": "2024年01月15日T10:30:00Z",
 "is_debug": false,
 "is_prerelease": false
 }
 },
 "runtime": {
 "started_at": "2024年01月15日T10:00:00+08:00",
 "uptime_seconds": 1800,
 "requests": {
 "total": 1250,
 "active": 3,
 "errors": 12
 }
 },
 "system": {
 "memory": {
 "used_bytes": 134217728,
 "used_percentage": 12.5,
 "available_bytes": 1073741824
 },
 "cpu": {
 "usage_percentage": 15.2,
 "load_average": [0.8, 1.2, 1.5]
 }
 },
 "capabilities": {
 "models": ["gpt-4", "claude-3"],
 "endpoints": ["/v1/chat/completions", "/v1/messages"],
 "features": [".."]
 }
}

字段说明

其他接口

随机生成一个uuid

string

随机生成一个hash

string

随机生成一个checksum

string

随机生成一个token(已弃用)

string

获取当前的checksum header

string

获取账号信息

{
 session_token: string,
 web_token: string,
 proxy_name?: string,
 include_sessions: bool
}

{
 token_profile: [
 null | {
 billing_cycle_start: string,
 billing_cycle_end: string,
 membership_type: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 limit_type: "user" | "team",
 is_unlimited: bool,
 individual_usage: {
 plan?: {
 enabled: bool,
 used: int32,
 limit: int32,
 remaining: int32,
 breakdown: {
 included: int32,
 bonus: int32,
 total: int32
 }
 },
 on_demand?: {
 enabled: bool,
 used: int32,
 limit?: int32,
 remaining?: int32
 }
 },
 team_usage: {
 plan?: {
 enabled: bool,
 used: int32,
 limit: int32,
 remaining: int32,
 breakdown: {
 included: int32,
 bonus: int32,
 total: int32
 }
 },
 on_demand?: {
 enabled: bool,
 used: int32,
 limit?: int32,
 remaining?: int32
 }
 },
 },
 null | {
 membership_type: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 payment_id?: string,
 days_remaining_on_trial: int32,
 subscription_status?: "trialing" | "active" | "incomplete" | "incomplete_expired" | "past_due" | "canceled" | "unpaid" | "paused",
 verified_student: bool,
 trial_eligible: bool,
 trial_length_days: int32,
 is_on_student_plan: bool,
 is_on_billable_auto: bool,
 customer_balance?: double,
 trial_was_cancelled: bool,
 is_team_member: bool,
 team_membership_type?: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise",
 individual_membership_type?: "free" | "free_trial" | "pro" | "pro_plus" | "ultra" | "enterprise"
 },
 null | {
 user_id: int32,
 email?: string,
 first_name?: string,
 last_name?: string,
 workos_id?: string,
 team_id?: number,
 created_at?: string,
 is_enterprise_user: bool,
 is_on_new_pricing: bool,
 privacy_mode_info: {
 privacy_mode: "unspecified" | "no_storage" | "no_training" | "usage_data_training_allowed" | "usage_codebase_training_allowed",
 is_enforced_by_team?: bool
 }
 },
 null | [
 {
 session_id: string,
 type: "unspecified" | "web" | "client" | "bugbot" | "background_agent",
 created_at: string,
 expires_at: string
 }
 ]
 ]
}

{
 "error": string
}

获取Config Version

{
 "token": string, // 格式: JWT
 "checksum": {
 "first": string, // 格式: 长度为64的Hex编码字符串
 "second": string, // 格式: 长度为64的Hex编码字符串
 },
 "client_key": string, // 格式: 长度为64的Hex编码字符串
 "session_id": string, // 格式: UUID
 "proxy_name": string, // 可选,指定代理
 "timezone": string, // 可选,指定时区
 "gcpp_host": string // 可选,代码补全区域
}

{
 "config_version": string // 成功时返回生成的UUID
}

{
 "error": string // 错误信息
}

获取更新令牌(已弃用)

{
 "token": string
}

{
 "status": "success" | "failure" | "error",
 "message": string,
 "result": string // optional
}

Copilot++ 接口文档

获取代码补全服务的配置信息

请求格式

{
 "is_nightly": bool, // 可选,是否使用nightly版本
 "model": string, // 模型名称
 "supports_cpt": bool // 可选,是否支持CPT
}

响应格式

{
 "above_radius": number, // 可选,上方扫描半径
 "below_radius": number, // 可选,下方扫描半径
 "merge_behavior": { // 可选,合并行为
 "type": string,
 "limit": number, // 可选,限制
 "radius": number // 可选,半径
 },
 "is_on": bool, // 可选,是否开启
 "is_ghost_text": bool, // 可选,是否使用幽灵文本
 "should_let_user_enable_cpp_even_if_not_pro": bool, // 可选,非专业用户是否可以启用
 "heuristics": [ // 启用的启发式规则列表
 "lots_of_added_text",
 "duplicating_line_after_suggestion",
 "duplicating_multiple_lines_after_suggestion",
 "reverting_user_change",
 "output_extends_beyond_range_and_is_repeated",
 "suggesting_recently_rejected_edit"
 ],
 "exclude_recently_viewed_files_patterns": [string], // 最近查看文件排除模式
 "enable_rvf_tracking": bool, // 是否启用RVF跟踪
 "global_debounce_duration_millis": number, // 全局去抖动时间(毫秒)
 "client_debounce_duration_millis": number, // 客户端去抖动时间(毫秒)
 "cpp_url": string, // CPP服务URL
 "use_whitespace_diff_history": bool, // 是否使用空白差异历史
 "import_prediction_config": { // 导入预测配置
 "is_disabled_by_backend": bool, // 是否被后端禁用
 "should_turn_on_automatically": bool, // 是否自动开启
 "python_enabled": bool // Python是否启用
 },
 "enable_filesync_debounce_skipping": bool, // 是否启用文件同步去抖动跳过
 "check_filesync_hash_percent": number, // 文件同步哈希检查百分比
 "geo_cpp_backend_url": string, // 地理位置CPP后端URL
 "recently_rejected_edit_thresholds": { // 可选,最近拒绝编辑阈值
 "hard_reject_threshold": number, // 硬拒绝阈值
 "soft_reject_threshold": number // 软拒绝阈值
 },
 "is_fused_cursor_prediction_model": bool, // 是否使用融合光标预测模型
 "include_unchanged_lines": bool, // 是否包含未更改行
 "should_fetch_rvf_text": bool, // 是否获取RVF文本
 "max_number_of_cleared_suggestions_since_last_accept": number, // 可选,上次接受后清除建议的最大数量
 "suggestion_hint_config": { // 可选,建议提示配置
 "important_lsp_extensions": [string], // 重要的LSP扩展
 "enabled_for_path_extensions": [string] // 启用的路径扩展
 }
}

获取可用的代码补全模型列表

请求格式

响应格式

{
 "models": [string], // 可用模型列表
 "default_model": string // 可选,默认模型
}

上传文件

请求格式

{
 "uuid": string, // 文件标识符
 "relative_workspace_path": string, // 文件相对于工作区的路径
 "contents": string, // 文件内容
 "model_version": number, // 模型版本
 "sha256_hash": string // 可选,文件的SHA256哈希值
}

响应格式

{
 "error": string // 错误类型:unspecified, non_existant, hash_mismatch
}

同步文件变更

请求格式

{
 "uuid": string, // 文件标识符
 "relative_workspace_path": string, // 文件相对于工作区的路径
 "model_version": number, // 模型版本
 "filesync_updates": [ // 文件同步更新数组
 {
 "model_version": number, // 模型版本
 "relative_workspace_path": string, // 文件相对于工作区的路径
 "updates": [ // 单个更新请求数组
 {
 "start_position": number, // 更新开始位置
 "end_position": number, // 更新结束位置
 "change_length": number, // 变更长度
 "replaced_string": string, // 替换的字符串
 "range": { // 简单范围
 "start_line_number": number, // 开始行号
 "start_column": number, // 开始列
 "end_line_number_inclusive": number, // 结束行号(包含)
 "end_column": number // 结束列
 }
 }
 ],
 "expected_file_length": number // 预期文件长度
 }
 ],
 "sha256_hash": string // 文件的SHA256哈希值
}

响应格式

{
 "error": string // 错误类型:unspecified, non_existant, hash_mismatch
}

流式代码补全

请求格式

{
 current_file: { // 当前文件信息
 relative_workspace_path: string, // 文件相对于工作区的路径
 contents: string, // 文件内容
 rely_on_filesync: bool, // 是否依赖文件同步
 sha_256_hash?: string, // 可选,文件内容SHA256哈希值
 top_chunks: [ // BM25检索的顶级代码块
 {
 content: string, // 代码块内容
 range: { // SimplestRange 最简单范围
 start_line: int32, // 开始行号
 end_line_inclusive: int32 // 结束行号(包含)
 },
 score: int32, // BM25分数
 relative_path: string // 代码块所在文件相对路径
 }
 ],
 contents_start_at_line: int32, // 内容开始行号(一般为0)
 cursor_position: { // CursorPosition 光标位置
 line: int32, // 行号(0-based)
 column: int32 // 列号(0-based)
 },
 dataframes: [ // DataframeInfo 数据框信息(用于数据分析场景)
 {
 name: string, // 数据框变量名
 shape: string, // 形状描述,如"(100, 5)"
 data_dimensionality: int32, // 数据维度
 columns: [ // 列定义
 {
 key: string, // 列名
 type: string // 列数据类型
 }
 ],
 row_count: int32, // 行数
 index_column: string // 索引列名称
 }
 ],
 total_number_of_lines: int32, // 文件总行数
 language_id: string, // 语言标识符(如"python", "rust")
 selection?: { // 可选,CursorRange 当前选中范围
 start_position: { // CursorPosition 开始位置
 line: int32, // 行号
 column: int32 // 列号
 },
 end_position: { // CursorPosition 结束位置
 line: int32, // 行号
 column: int32 // 列号
 }
 },
 alternative_version_id?: int32, // 可选,备选版本ID
 diagnostics: [ // Diagnostic 诊断信息数组
 {
 message: string, // 诊断消息内容
 range: { // CursorRange 诊断范围
 start_position: { // CursorPosition 开始位置
 line: int32, // 行号
 column: int32 // 列号
 },
 end_position: { // CursorPosition 结束位置
 line: int32, // 行号
 column: int32 // 列号
 }
 },
 severity: "error" | "warning" | "information" | "hint", // DiagnosticSeverity 严重程度
 related_information: [ // RelatedInformation 相关信息
 {
 message: string, // 相关信息消息
 range: { // CursorRange 相关信息范围
 start_position: { // CursorPosition 开始位置
 line: int32, // 行号
 column: int32 // 列号
 },
 end_position: { // CursorPosition 结束位置
 line: int32, // 行号
 column: int32 // 列号
 }
 }
 }
 ]
 }
 ],
 file_version?: int32, // 可选,文件版本号(用于增量更新)
 workspace_root_path: string, // 工作区根路径(绝对路径)
 line_ending?: string, // 可选,行结束符("\n" 或 "\r\n")
 file_git_context: { // FileGit Git上下文信息
 commits: [ // GitCommit 相关提交数组
 {
 commit: string, // 提交哈希
 author: string, // 作者
 date: string, // 提交日期
 message: string // 提交消息
 }
 ]
 }
 },
 diff_history: [string], // 差异历史(已弃用,使用file_diff_histories代替)
 model_name?: string, // 可选,指定使用的模型名称
 linter_errors?: { // 可选,LinterErrors Linter错误信息
 relative_workspace_path: string, // 错误所在文件相对路径
 errors: [ // LinterError 错误数组
 {
 message: string, // 错误消息
 range: { // CursorRange 错误范围
 start_position: { // CursorPosition 开始位置
 line: int32, // 行号
 column: int32 // 列号
 },
 end_position: { // CursorPosition 结束位置
 line: int32, // 行号
 column: int32 // 列号
 }
 },
 source?: string, // 可选,错误来源(如"eslint", "pyright")
 related_information: [ // Diagnostic.RelatedInformation 相关信息
 {
 message: string, // 相关信息消息
 range: { // CursorRange 相关信息范围
 start_position: { // CursorPosition 开始位置
 line: int32, // 行号
 column: int32 // 列号
 },
 end_position: { // CursorPosition 结束位置
 line: int32, // 行号
 column: int32 // 列号
 }
 }
 }
 ],
 severity?: "error" | "warning" | "information" | "hint" // 可选,DiagnosticSeverity 严重程度
 }
 ],
 file_contents: string // 文件内容(用于错误上下文)
 },
 context_items: [ // CppContextItem 上下文项数组
 {
 contents: string, // 上下文内容
 symbol?: string, // 可选,符号名称
 relative_workspace_path: string, // 上下文所在文件相对路径
 score: float // 相关性分数
 }
 ],
 diff_history_keys: [string], // 差异历史键(已弃用)
 give_debug_output?: bool, // 可选,是否输出调试信息
 file_diff_histories: [ // CppFileDiffHistory 文件差异历史数组
 {
 file_name: string, // 文件名
 diff_history: [string], // 差异历史数组,格式:"行号-|旧内容\n行号+|新内容\n"
 diff_history_timestamps: [double] // 差异时间戳数组(Unix毫秒时间戳)
 }
 ],
 merged_diff_histories: [ // CppFileDiffHistory 合并后的差异历史
 {
 file_name: string, // 文件名
 diff_history: [string], // 合并后的差异历史
 diff_history_timestamps: [double] // 时间戳数组
 }
 ],
 block_diff_patches: [ // BlockDiffPatch 块级差异补丁
 {
 start_model_window: { // ModelWindow 模型窗口起始状态
 lines: [string], // 窗口内的代码行
 start_line_number: int32, // 窗口起始行号
 end_line_number: int32 // 窗口结束行号
 },
 changes: [ // Change 变更数组
 {
 text: string, // 变更后的文本
 range: { // IRange 变更范围
 start_line_number: int32, // 起始行号
 start_column: int32, // 起始列号
 end_line_number: int32, // 结束行号
 end_column: int32 // 结束列号
 }
 }
 ],
 relative_path: string, // 文件相对路径
 model_uuid: string, // 模型UUID(用于追踪补全来源)
 start_from_change_index: int32 // 从第几个change开始应用
 }
 ],
 is_nightly?: bool, // 可选,是否为nightly构建版本
 is_debug?: bool, // 可选,是否为调试模式
 immediately_ack?: bool, // 可选,是否立即确认请求
 enable_more_context?: bool, // 可选,是否启用更多上下文检索
 parameter_hints: [ // CppParameterHint 参数提示数组
 {
 label: string, // 参数标签(如"x: int")
 documentation?: string // 可选,参数文档说明
 }
 ],
 lsp_contexts: [ // LspSubgraphFullContext LSP子图上下文
 {
 uri?: string, // 可选,文件URI
 symbol_name: string, // 符号名称
 positions: [ // LspSubgraphPosition 位置数组
 {
 line: int32, // 行号
 character: int32 // 字符位置
 }
 ],
 context_items: [ // LspSubgraphContextItem 上下文项
 {
 uri?: string, // 可选,URI
 type: string, // 类型(如"definition", "reference")
 content: string, // 内容
 range?: { // 可选,LspSubgraphRange 范围
 start_line: int32, // 起始行
 start_character: int32, // 起始字符
 end_line: int32, // 结束行
 end_character: int32 // 结束字符
 }
 }
 ],
 score: float // 相关性分数
 }
 ],
 cpp_intent_info?: { // 可选,CppIntentInfo 代码补全意图信息
 source: "line_change" | "typing" | "option_hold" | // 触发来源
 "linter_errors" | "parameter_hints" | 
 "cursor_prediction" | "manual_trigger" | 
 "editor_change" | "lsp_suggestions"
 },
 workspace_id?: string, // 可选,工作区唯一标识符
 additional_files: [ // AdditionalFile 附加文件数组
 {
 relative_workspace_path: string, // 文件相对路径
 is_open: bool, // 是否在编辑器中打开
 visible_range_content: [string], // 可见范围的内容(按行)
 last_viewed_at?: double, // 可选,最后查看时间(Unix毫秒时间戳)
 start_line_number_one_indexed: [int32], // 可见范围起始行号(1-based索引)
 visible_ranges: [ // LineRange 可见范围数组
 {
 start_line_number: int32, // 起始行号
 end_line_number_inclusive: int32 // 结束行号(包含)
 }
 ]
 }
 ],
 control_token?: "quiet" | "loud" | "op", // 可选,ControlToken 控制标记
 client_time?: double, // 可选,客户端时间(Unix毫秒时间戳)
 filesync_updates: [ // FilesyncUpdateWithModelVersion 文件同步增量更新
 {
 model_version: int32, // 模型版本号
 relative_workspace_path: string, // 文件相对路径
 updates: [ // SingleUpdateRequest 更新操作数组
 {
 start_position: int32, // 起始位置(字符偏移量,0-based)
 end_position: int32, // 结束位置(字符偏移量,0-based)
 change_length: int32, // 变更后的长度
 replaced_string: string, // 替换的字符串内容
 range: { // SimpleRange 变更范围
 start_line_number: int32, // 起始行号
 start_column: int32, // 起始列号
 end_line_number_inclusive: int32, // 结束行号(包含)
 end_column: int32 // 结束列号
 }
 }
 ],
 expected_file_length: int32 // 应用更新后预期的文件长度
 }
 ],
 time_since_request_start: double, // 从请求开始到当前的时间(毫秒)
 time_at_request_send: double, // 请求发送时的时间戳(Unix毫秒时间戳)
 client_timezone_offset?: double, // 可选,客户端时区偏移(分钟,如-480表示UTC+8)
 lsp_suggested_items?: { // 可选,LspSuggestedItems LSP建议项
 suggestions: [ // LspSuggestion 建议数组
 {
 label: string // 建议标签
 }
 ]
 },
 supports_cpt?: bool, // 可选,是否支持CPT(Code Patch Token)格式
 supports_crlf_cpt?: bool, // 可选,是否支持CRLF换行的CPT格式
 code_results: [ // CodeResult 代码检索结果
 {
 code_block: { // CodeBlock 代码块
 relative_workspace_path: string, // 文件相对路径
 file_contents?: string, // 可选,完整文件内容
 file_contents_length?: int32, // 可选,文件内容长度
 range: { // CursorRange 代码块范围
 start_position: { // CursorPosition 开始位置
 line: int32, // 行号
 column: int32 // 列号
 },
 end_position: { // CursorPosition 结束位置
 line: int32, // 行号
 column: int32 // 列号
 }
 },
 contents: string, // 代码块内容
 signatures: { // Signatures 签名信息
 ranges: [ // CursorRange 签名范围数组
 {
 start_position: { // CursorPosition 开始位置
 line: int32, // 行号
 column: int32 // 列号
 },
 end_position: { // CursorPosition 结束位置
 line: int32, // 行号
 column: int32 // 列号
 }
 }
 ]
 },
 override_contents?: string, // 可选,覆盖内容
 original_contents?: string, // 可选,原始内容
 detailed_lines: [ // DetailedLine 详细行信息
 {
 text: string, // 行文本
 line_number: float, // 行号(浮点数用于支持虚拟行)
 is_signature: bool // 是否为签名行
 }
 ],
 file_git_context: { // FileGit Git上下文
 commits: [ // GitCommit 提交数组
 {
 commit: string, // 提交哈希
 author: string, // 作者
 date: string, // 提交日期
 message: string // 提交消息
 }
 ]
 }
 },
 score: float // 检索相关性分数
 }
 ]
}

响应格式 (SSE 流)

事件类型

{
 type: "model_info",
 is_fused_cursor_prediction_model: bool,
 is_multidiff_model: bool
}

{
 type: "range_replace",
 start_line_number: int32, // 起始行(1-based)
 end_line_number_inclusive: int32, // 结束行(1-based,包含)
 binding_id?: string,
 should_remove_leading_eol?: bool
}

{
 type: "text",
 text: string
}

{
 type: "cursor_prediction",
 relative_path: string,
 line_number_one_indexed: int32,
 expected_content: string,
 should_retrigger_cpp: bool,
 binding_id?: string
}

{
 type: "done_edit"
}

{
 type: "begin_edit"
}

{
 type: "done_stream"
}

{
 type: "debug",
 model_input?: string,
 model_output?: string,
 stream_time?: string,
 total_time?: string,
 ttft_time?: string,
 server_timing?: string
}

{
 type: "error",
 error: {
 code: uint16, // 非零错误码
 type: string, // 错误类型
 details?: { // 可选的详细信息
 title: string,
 detail: string,
 additional_info?: Record<string, string>
 }
 }
}

{
 type: "stream_end"
}

典型消息序列

model_info
range_replace // 指定范围
text (×ばつN) // 流式文本
done_edit
done_stream
debug (×ばつN) // 可选的多个调试消息
stream_end

model_info
range_replace
text (×ばつN)
done_edit
begin_edit // 下一次编辑
range_replace
text (×ばつN)
cursor_prediction // 可选
done_edit
done_stream
stream_end

客户端处理要点

鸣谢

关于赞助