mirror of https://git.openapi.site/https://github.com/desirecore/market.git synced 2026-07-23 02:43:47 +08:00

Files

合并市场索引、分类、i18n 校验、skill-creator 工具和已修改 skill 版本号更新。

2026-07-07 21:14:31 +08:00

7.8 KiB

Raw Blame History

name, description, version, type, risk_level, status, disable-model-invocation, tags, metadata, market

name

description

version

type

risk_level

status

disable-model-invocation

Configure Compute

Help the user configure compute providers — model API endpoints and API keys — through the Agent Service HTTP API.

Security model (read this first, non-negotiable)

API keys are write-only. You can create and overwrite keys; you can NEVER read an existing key back. There is no API that returns key plaintext to you, GET /api/compute/config returns masked values only, and the runtime blocks file reads of secrets.json (Read/Grep tools and shell commands alike).
Do not try to work around this. Never attempt to read ~/.desirecore/config/secrets.json, never echo a key the user gave you back into chat more than necessary, never store keys anywhere except via POST /api/compute/secrets.
If the user asks "what is my current key", answer: keys cannot be read back; they can only be replaced. Point them to the provider settings UI, which has a user-only reveal control.

How to call the API

Prefer the Bash tool with curl. The API base URL is already injected into the "Local API" section of the system prompt; reference it directly.
On Windows without Git Bash, use the HttpRequest tool with the same URLs.

Workflow

1. Inspect current configuration

curl -s $BASE/api/compute/config

Response contains providers[] where apiKey is a masked display value (first 4 chars + bullets) and hasApiKey: boolean tells you whether a key is configured. Use this to decide between creating a new provider and updating an existing one. Never treat the masked apiKey as a real key.

2. Create a provider (if needed)

curl -s -X POST $BASE/api/compute/providers \
  -H 'Content-Type: application/json' \
  -d '{
    "provider": "deepseek",
    "label": "DeepSeek",
    "baseUrl": "https://api.deepseek.com",
    "services": ["chat"],
    "apiFormat": "openai-completions",
    "priceCurrency": "CNY"
  }'

Required fields: provider, label, baseUrl, services. The response returns the created provider with its generated id — keep it for later steps. Known provider presets and model lists are available via GET /api/compute/pi-providers and GET /api/compute/pi-models/:provider.

3. Set the API key (write-only)

Ask the user for the key. Reuse the provider's existing apiKeyRef if set; otherwise generate one like key-<random> and attach it to the provider:

# Write the secret (write-only endpoint; there is no GET counterpart)
curl -s -X POST $BASE/api/compute/secrets \
  -H 'Content-Type: application/json' \
  -d '{"ref": "key-abc123", "value": "<API_KEY_FROM_USER>"}'

# Attach the ref to the provider if it was not set yet
curl -s -X PUT $BASE/api/compute/providers/<id> \
  -H 'Content-Type: application/json' \
  -d '{"apiKeyRef": "key-abc123"}'

4. Verify the key

curl -s -X POST $BASE/api/compute/verify-key \
  -H 'Content-Type: application/json' \
  -d '{"provider": "deepseek", "baseUrl": "https://api.deepseek.com", "apiKeyRef": "key-abc123", "apiFormat": "openai-completions"}'

Returns { valid, latencyMs, errorMessage?, suggestedBaseUrl? }. If suggestedBaseUrl is present, offer to update the provider's baseUrl.

5. Enable and populate models

curl -s -X PUT $BASE/api/compute/providers/<id> \
  -H 'Content-Type: application/json' -d '{"enabled": true}'

# Optional: sync the model list from the built-in registry
curl -s -X POST $BASE/api/compute/sync-models/<id>

6. Reload so the UI reflects the change

Always finish with:

curl -s -X POST $BASE/api/compute/reload

This re-validates the configuration and broadcasts a refresh event to the client UI. Report the returned providerCount / enabledProviderCount / modelCount to the user as confirmation.

Endpoint reference

Method	Path	Purpose
GET	`/api/compute/config`	Full config; `apiKey` masked + `hasApiKey`
POST	`/api/compute/providers`	Create provider
PUT	`/api/compute/providers/:id`	Patch provider (label/baseUrl/enabled/apiFormat/apiKeyRef/...)
DELETE	`/api/compute/providers/:id`	Remove provider
POST	`/api/compute/secrets`	Write key `{ref, value}` — write-only
DELETE	`/api/compute/secrets/:ref`	Delete key
POST	`/api/compute/verify-key`	Probe a key end-to-end
POST	`/api/compute/sync-models/:id`	Sync model list from registry
POST	`/api/compute/reload`	Re-validate config + broadcast UI refresh
GET	`/api/compute/pi-providers`	Known provider presets
GET	`/api/compute/pi-models/:provider`	Known models for a preset

Error handling

Symptom	Cause	Action
400 on create	Missing required field / unknown field	Fix the request body (schema is strict, `additionalProperties: false`)
404 on PUT	Wrong provider id	Re-list via GET config
`valid: false` on verify	Wrong key / wrong baseUrl / wrong apiFormat	Show `errorMessage` to the user; try `suggestedBaseUrl` if present
403 anywhere	You tried a credential-gated endpoint (key reveal)	Stop — that endpoint is for the human user's UI only

Confirmation etiquette

Before overwriting an existing key (hasApiKey: true), confirm with the user.
Before deleting a provider or key, confirm with the user.
After finishing, summarize what changed (provider, enabled state, model count) without repeating the key value.

7.8 KiB Raw Blame History Unescape Escape