Skip to main content
Skills

Get a Skill

Forward API reference.

Description

Retrieves a single Skill by ID, optionally including its content.

Path

GET /api/v1/forward/skills/{id}

Request headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT or SAT>

Path parameters

ParameterTypeRequiredDescription
idstringYesSkill ID.

Query parameters

ParameterTypeRequiredDescription
identity_idstringNoUse only when operating on Identity-owned resources. A PAT can explicitly supply this query parameter; omitting it uses administrator scope. SAT ownership is determined by the credential. Explicitly supplying this parameter with any SAT (including an empty value) returns HTTP 400. See Identity ownership.
include_contentbooleanNo⚠️ Deprecated: When true, the response includes content and content_encoding (base64 zip) and returns Deprecation: true in the response headers. Use Download Skill Version Content instead.

Example request

curl -X GET "https://api.qoder.com.cn/api/v1/forward/skills/skill_xxx" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK
{
  "id": "skill_xxx",
  "type": "skill",
  "display_title": "customer-reply",
  "description": "Customer reply skill",
  "source": "custom",
  "latest_version": "1759178010641129",
  "metadata": {"source": "console"},
  "created_at": "2026-07-23T10:00:00Z",
  "updated_at": "2026-07-23T10:00:00Z",
  "identity_id": null,
  "icon_url": null,
  "binding_info": {"agent_template_count": 0}
}

Response fields

The response is a Skill object. With include_content=true, it also includes content and content_encoding; both fields are deprecated. Use Download Skill Version Content instead.

Errors

HTTPTypeTrigger
400invalid_request_errorThe request body, path parameters, or query parameters are invalid; this includes explicitly supplying the query parameter identity_id with any SAT, even with an empty value.
401authentication_errorThe authentication token is missing or invalid.
403permission_errorAn Owner mismatch occurs in administrator scope, or a downstream service denies access.
404not_found_errorThe Skill does not exist or is not visible in the current Identity scope; the Identity specified by the PAT is invalid, disabled, deleted, or outside the caller's authorized scope.
500/502/503api_errorForward or a dependent service failed.
Best Practices
API reference