Skip to content

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

qca-api-helper

Qoder Cloud Agents (QCA) REST API 集成 Skill

将 Qoder Cloud Agents 平台完整官方 API 文档(三层架构 / 17 资源族 / ~136 端点)打包为一个 AI Agent Skill,让 AI 编程助手在你自己的项目中生成正确的 QCA 集成代码——无需翻阅官网文档。

概述

Qoder Cloud Agents (QCA) 是一个 Agent-as-a-Service 平台,提供 REST API 让开发者在自己的应用中集成 AI Agent 能力。

本 Skill 适用于:

  • 在自己的代码/项目中 集成、调用或调试 QCA API
  • 从其他 AI 平台 API 迁移到 QCA API
  • 创建 Agent、启动 Session、收发 SSE 事件流
  • 管理 Environment / Skill / Vault / File / Memory Store 等共享资产
  • 使用 Forward 模式的 Template / Identity / Channel(飞书/钉钉/微信 IM 接入)/ Schedule / Batch

架构概览

QCA 由两种 Mode + 一层共享资产组成:

Base URL 适用场景
🟢 Forward Mode https://api.qoder.com/api/v1/forward 业务集成方 / SaaS / IM 渠道接入 / 终端用户身份隔离
🟡 Managed Mode https://api.qoder.com/api/v1/cloud Agent 开发者 / 全托管原子化运行时
🔵 Resources 层 https://api.qoder.com/api/v1/cloud 组织级共享资产(Environment/Skill/Vault/File/Memory/Model)

项目结构

qca-api-helper/
├── SKILL.md                    # Skill 入口文件(路由器 + 通用约定 + 工作流)
└── references/
    └── api-docs/               # 完整官方 API 文档(只读参考资料)
        ├── Qoder-Cloud-Agents-三层API目录.md
        └── release-api/
            ├── 01-使用指引/     # API 概览与快速入门
            ├── 02-通用约定/     # 认证、错误码、分页、Schema 等
            ├── 03-Forward层/    # Forward Mode 全部端点
            │   ├── Batches/
            │   ├── Channels/
            │   ├── Identities/
            │   ├── Resources/
            │   ├── Schedules/
            │   ├── Sessions/
            │   ├── Templates/
            │   └── Usage/
            ├── 04-Managed层/    # Managed Mode 全部端点
            │   ├── Agents/
            │   ├── Deployments/
            │   ├── Dreams/
            │   └── Sessions/
            └── 05-Resources层/  # 共享资产全部端点
                ├── Environments/
                ├── Files/
                ├── Memory Stores/
                ├── Models/
                ├── Skills/
                └── Vaults/

如何使用

作为 Qoder Skill 使用

  1. 将本项目克隆到你的 Qoder 工作区中
  2. 在 Qoder 的 Skill 配置中引用 SKILL.md
  3. 当你需要集成 QCA API 时,AI 助手会自动查阅 references/api-docs/ 下的文档并生成正确的代码

作为 API 文档参考

即使不使用 Qoder,references/api-docs/ 目录下的 Markdown 文档本身也是一份完整的 QCA API 参考资料,可直接阅读。

快速开始

# 验证 PAT 连通性
curl -H "Authorization: Bearer $QODER_PAT" \
  https://api.qoder.com/api/v1/cloud/agents?limit=1

# 创建 Agent → Session → 发消息 → 收 SSE 事件
# 详见 references/api-docs/release-api/04-Managed层/quickstart.md

认证

所有请求头带 Authorization: Bearer $QODER_PAT。PAT 以 pt- 前缀开头,在 Qoder 控制台「设置 → API 令牌」创建。

安全提示:永远使用环境变量传递 PAT,禁止硬编码或提交进仓库。

许可证

本项目中的 API 文档内容版权归 Qoder 所有。Skill 封装部分采用 MIT License 开源。

相关链接

About

Qoder Cloud Agents (QCA) REST API integration Skill for AI coding assistants

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors