本文へ移動
cccskills
無料GitHub で公開

http-api-cloudbase

CloudBase official HTTP API client guide. This skill should be used when backends, scripts, or non-SDK clients must call CloudBase platform APIs over raw HTTP instead of using a platform SDK or MCP management tool.

TencentCloudBase/CloudBase-AI-Toolkit
インストール方法を見る

含まれるファイル（4）

  • SKILL.md8.3 KB
  • checklist.md1.9 KB
  • LICENSE.md1.0 KB
  • references/extended-guide.md15.5 KB

SKILL.md（原文）

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Sibling skills (local only)

Sibling CloudBase skills ship beside this skill. Use local relative paths such as ../auth-tool-cloudbase/SKILL.md.

If a referenced sibling skill file is missing from this environment, ask the user to install the full CloudBase plugin (or the missing skill). Do not HTTP-fetch remote skill or protocol markdown into the agent context.

Activation Contract

Use this first when

  • The request comes from Android, iOS, Flutter, React Native, non-Node backends, or admin scripts that must call official CloudBase APIs via raw HTTP.
  • The task is to consume CloudBase platform endpoints, not to build a new HTTP service on CloudBase.

Read before writing code if

  • The platform does not support a CloudBase SDK, or the user explicitly asks for HTTP API integration.
  • The user says "HTTP API" but it is unclear whether they mean official CloudBase endpoints or their own business API.

Then also read

  • Auth configuration -> ../auth-tool-cloudbase/SKILL.md
  • MySQL MCP management -> ../relational-database-mcp-cloudbase/SKILL.md
  • Your own HTTP service on CloudBase -> ../cloud-functions/SKILL.md or ../cloudrun-development/SKILL.md

Do NOT use for

  • CloudBase Web SDK flows, mini program SDK flows, or MCP-driven management tasks.
  • Building your own HTTP service or REST API on CloudBase.

Common mistakes / gotchas

  • Treating Web SDK examples as valid for native Apps.
  • Guessing endpoints without reading OpenAPI definitions.
  • Confusing official CloudBase HTTP APIs with your own function or CloudRun endpoint.
  • Mixing raw HTTP API integration with MCP management logic.

Minimal checklist

When to use this skill

Use this skill whenever you need to call CloudBase platform features via raw HTTP APIs, for example:

  • Non-Node backends (Go, Python, Java, PHP, etc.)
  • Integration tests or admin scripts that use curl or language HTTP clients
  • Direct database operations via 关系型数据库 RESTful API (MySQL/PostgreSQL)
  • Cloud function invocation via HTTP
  • Any scenario where SDKs are not available or not preferred

Do not use this skill for:

  • Frontend Web apps using @cloudbase/js-sdk (use CloudBase Web skills)
  • Node.js code using @cloudbase/node-sdk (use CloudBase Node skills)
  • Authentication flows (use CloudBase Auth HTTP API skill for auth-specific endpoints)

How to use this skill (for a coding agent)

  1. Clarify the scenario

    • Confirm this code will call HTTP endpoints directly (not SDKs).
    • Ask for:
      • env – CloudBase environment ID
      • Authentication method (AccessToken, API Key, or Publishable Key)
    • Confirm which CloudBase feature is needed (database, functions, storage, etc.).
    • For user authentication: If no specific method is requested, always default to Phone SMS Verification - it's the most user-friendly and secure option for Chinese users.

  2. Determine the base URL

    • Use the correct domain based on region (domestic vs. international).
    • Default is domestic Shanghai region.

  3. Set up authentication

    • Choose appropriate authentication method based on use case.
    • Add Authorization: Bearer <token> header to requests.

  4. Reference OpenAPI Swagger documentation

    • MUST use searchKnowledgeBase tool to get OpenAPI specifications
    • Use the tool with mode=openapi and specify the apiName:
      • mysqldb - 关系型数据库 RESTful API (MySQL/PostgreSQL)
      • nosql - NoSQL RESTful API (文档型数据库)
      • functions - Cloud Functions API
      • auth - Authentication API
      • cloudrun - CloudRun API
      • storage - Storage API
      • ai_model - AI 大模型接入 API
    • Example: searchKnowledgeBase({ mode: "openapi", apiName: "mysqldb" })
    • Parse the returned YAML content to understand exact endpoint paths, parameters, request/response schemas
    • Never invent endpoints or parameters - always reference the swagger documentation

Overview

CloudBase HTTP API is a set of interfaces for accessing CloudBase platform features via HTTP protocol, supporting database, user authentication, cloud functions, cloud hosting, cloud storage, AI, and more.

OpenAPI Swagger Documentation

⚠️ IMPORTANT: Always use searchKnowledgeBase tool to get OpenAPI Swagger specifications

Before implementing any HTTP API calls, you should:

  1. Use searchKnowledgeBase tool to get OpenAPI documentation:

    searchKnowledgeBase({ mode: "openapi", apiName: "<api-name>" })

  2. Available API names:

    • mysqldb - 关系型数据库 RESTful API (MySQL/PostgreSQL)
    • nosql - NoSQL RESTful API (文档型数据库)
    • functions - Cloud Functions API
    • auth - Authentication API
    • cloudrun - CloudRun API
    • storage - Storage API
    • ai_model - AI 大模型接入 API

  3. Parse and use the swagger documentation:

    • Extract exact endpoint paths and HTTP methods
    • Understand required and optional parameters
    • Review request/response schemas
    • Check authentication requirements
    • Verify error response formats

  4. Never invent API endpoints or parameters - always base your implementation on the official swagger documentation.

Prerequisites

Before starting, ensure you have:

  1. CloudBase environment created and activated
  2. Authentication credentials (AccessToken, API Key, or Publishable Key)

Authentication and Authorization

CloudBase HTTP API requires authentication. Choose the appropriate method based on your use case:

AccessToken Authentication

Applicable environments: Client/Server
User permissions: Logged-in user permissions

How to get: Use searchKnowledgeBase({ mode: "openapi", apiName: "auth" }) to get the Authentication API specification

API Key

Applicable environments: Server
User permissions: Administrator permissions

⚠️ Warning: Tokens are critical credentials for identity authentication. Keep them secure. API Key must NOT be used in client-side code.

Publishable Key

Applicable environments: Client/Server
User permissions: Anonymous user permissions

💡 Note: Can be exposed in browsers, used for requesting publicly accessible resources, effectively reducing MAU.

API Endpoint URLs

CloudBase HTTP API uses unified domain names for API calls. The domain varies based on the environment's region.

Domestic Regions

For environments in domestic regions like Shanghai (ap-shanghai), use:

https://{your-env}.api.tcloudbasegateway.com

Replace {your-env} with the actual environment ID. For example, if environment ID is cloud1-abc:

https://cloud1-abc.api.tcloudbasegateway.com

International Regions

For environments in international regions like Singapore (ap-singapore), use:

https://{your-env}.api.intl.tcloudbasegateway.com

Replace {your-env} with the actual environment ID. For example, if environment ID is cloud1-abc:

https://cloud1-abc.api.intl.tcloudbasegateway.com

Using Authentication in Requests

Add the token to the request header:

Authorization: Bearer <access_token/apikey/publishable_key>

:::warning Note

When making actual calls, replace the entire part including angle brackets (< >) with your obtained key. For example, if the obtained key is eymykey, fill it as:

Authorization: Bearer eymykey

:::

Extended guide

For detailed scenarios, examples, and patterns, read extended-guide.md.

Reference index

All packaged reference files (required for skill lint reachability):

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

ログインしてレビューを書く

同じリポジトリのスキル

概要と使いどころ

ai-model-nodejs

無料

Use this skill for Node.js backend AI via @cloudbase/node-sdk (>=3.16.0) — cloud functions, CloudRun, Express/Koa/NestJS, serverless APIs, scheduled jobs, LLM proxies, agent orchestration. The only SDK supporting image generation (ai.createImageModel + generateImage). Text via ai.createModel with groups cloudbase, hunyuan-exp, or custom-*; model ids (e.g. deepseek-v4-flash, glm-5, kimi-k2.6) go in the `model` field of generateText/streamText. MUST run two-step preflight before code — see body. NOT for browser/Web (use ai-model-web) or Mini Program (use ai-model-wechat).

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloudBase/CloudBase-AI-Toolkit1,1362026年10月11日 更新

ai-model-web

無料

Use this skill when a browser/Web app (React, Vue, Next, Nuxt, static sites, SPAs, dashboards, AI chat UI, 页面, 前端, 网页) needs AI models via @cloudbase/js-sdk. Default routing for Web/frontend AI — call directly from the browser, do NOT propose a Node.js proxy. Covers generateText and streamText; models via ai.createModel with groups cloudbase, hunyuan-exp, or custom-*, model id in the `model` field. MUST run two-step preflight before code — see body. NOT for Node.js backend (use ai-model-nodejs), Mini Program (use ai-model-wechat), or image generation (Node SDK only).

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloudBase/CloudBase-AI-Toolkit1,1362026年10月11日 更新

ai-model-wechat

無料

Use this skill for WeChat Mini Program AI via wx.cloud.extend.AI (小程序, wx.cloud apps). Covers generateText and streamText with callbacks (onText, onEvent, onFinish); streamText needs a data wrapper, generateText returns the raw response. Models via wx.cloud.extend.AI.createModel with groups hunyuan-exp (小程序成长计划), cloudbase (main managed), or custom-*; model id goes in the data wrapper `model` field. MUST run two-step preflight before code — see body. NOT for browser/Web (use ai-model-web), Node.js backend (use ai-model-nodejs), or image generation (use ai-model-nodejs).

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloudBase/CloudBase-AI-Toolkit1,1362026年10月11日 更新

api-contract-review

無料

Use when auditing CloudBase cloud API wrappers, MCP tools, generated action metadata, or related docs for outdated or incorrect action names, parameters, casing, request shapes, or missing contract tests, especially during periodic quality review or before preparing corrective PRs.

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloudBase/CloudBase-AI-Toolkit1,1362026年10月11日 更新

auth-nodejs-cloudbase

無料

CloudBase Node SDK auth guide for server-side identity, user lookup, and custom login tickets. This skill should be used when Node.js code must read caller identity, inspect end users, or bridge an existing user system into CloudBase; not when configuring providers or building client login UI.

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloudBase/CloudBase-AI-Toolkit1,1362026年10月11日 更新

auth-tool-cloudbase

無料

CloudBase auth provider configuration and login-readiness guide. This skill should be used when users need to inspect, enable, disable, or configure auth providers, publishable-key prerequisites, login methods, SMS/email sender setup, or other provider-side readiness before implementing a client or backend auth flow.

日本語の概要は準備中です。原文の説明を表示しています。

TencentCloudBase/CloudBase-AI-Toolkit1,1362026年10月11日 更新

TencentCloudBase のスキルをすべて見る

このスキルの問題を報告する