
Volcengine Api
- 34 installs
- 411 repo stars
- Updated August 4, 2026
- bytedance/agentkit-samples
volcengine-api is a Claude skill that answers Volcengine API specification questions by querying the live API Explorer.
About
volcengine-api is a Claude skill that answers questions about Volcengine API specifications by querying the live API Explorer endpoints. It looks up API parameters, enum values, required fields, response structures, pagination, parameter dependencies, and error codes across Volcengine services. A developer uses it to find the right API and its exact parameters before writing a call. It hands off to volcengine-sdk-generator for code and volcengine-cli for operations.
- Answers Volcengine API questions from the live API Explorer
- Covers parameters, enums, required fields, responses, pagination and error codes
- Hands off to volcengine-sdk-generator for code and volcengine-cli for operations
Volcengine Api by the numbers
- 34 all-time installs (skills.sh)
- Ranked #3,343 of 4,347 Backend & APIs skills by installs in the Skillselion catalog
- Data as of Aug 5, 2026 (Skillselion catalog sync)
volcengine-api capabilities & compatibility
Queries public API Explorer endpoints; no API key stated
- Capabilities
- api lookup · error code lookup
- Use cases
- api development · research
- Runs
- Runs locally
- Pricing
- Free
What volcengine-api says it does
Answer user questions about Volcengine APIs by querying the API Explorer for authoritative, up-to-date information.
When the user needs runnable SDK code, hand off to the volcengine-sdk-generator skill.
npx skills add https://github.com/bytedance/agentkit-samples --skill volcengine-apiAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 34 |
|---|---|
| repo stars | ★ 411 |
| Last updated | August 4, 2026 |
| Repository | bytedance/agentkit-samples ↗ |
What it does
Look up Volcengine API parameters, enums, responses, and error codes from the live API Explorer.
Who is it for?
Finding a Volcengine API and its exact parameters, responses, and error codes.
Skip if: Generating runnable SDK code (use volcengine-sdk-generator) or running CLI operations (use volcengine-cli).
When should I use this skill?
You need authoritative Volcengine API parameters, enums, or error-code meanings.
What you get
You get authoritative API details straight from the API Explorer.
- API parameters, enums, required fields, response fields and error-code explanations
By the numbers
- maps eight query intents (find API, params, response, dependencies, pagination, errors, browse, compare) to explorer sub
Files
Volcengine API Query Assistant
Answer user questions about Volcengine APIs by querying the API Explorer for authoritative, up-to-date information.
Applicable Scenarios
| Scenario | Example Questions |
|---|---|
| Find an API | "How do I list ECS instances?", "Is there a batch tag creation API?" |
| Query parameters | "What are the required params for RunInstances?", "What values does ChargeType accept?" |
| Response structure | "What fields does DescribeInstances return?", "What statuses can Status have?" |
| Parameter dependencies | "If I set Ipv6Isp, how should I fill Ipv6MaskLen?", "When is SpotPriceLimit required?" |
| Pagination | "How do I paginate instance queries?", "How does NextToken work?" |
| Error codes | "What does InvalidInstanceId.NotFound mean?", "CreateVpc returns QuotaExceeded" |
| Browse services | "Which APIs does ECS have?", "What operations does VPC support?" |
| API comparison | "What's the difference between DescribeInstances and DescribeInstancesByIds?" |
Workflow
Step 1: Understand User Intent
Determine what the user is looking for:
| Intent | Signal | Query Path |
|---|---|---|
| Find an API | Describes an operation but doesn't know the API name | Search (2e) or Services (2a) -> API list (2c) -> Details (2d) |
| Query parameters | Knows the API name, asks about params/enums/required fields | Go directly to Details (2d) |
| Query response | Asks about return fields or status values | Go directly to Details (2d), focus on response schema |
| Query parameter dependencies | Asks "when is X required?" or "how does X relate to Y?" | Go directly to Details (2d), focus on conditional rules in descriptions |
| Query error codes | Provides an error code or error message | Error code handling (Step 3) |
| Browse a service | Asks what capabilities a service offers | Services (2a) -> API list (2c) |
| Compare APIs | Asks about differences between two APIs | Query Details (2d) for each, compare params and functionality |
Step 2: Query API Information Progressively
Start from the appropriate sub-step based on what is already known. When the user describes a requirement in natural language, Search (2e) is often faster than browsing level by level.
2a. Query service list (when the service is unknown)
GET https://api.volcengine.com/api/common/explorer/servicesEach service in the response contains:
ServiceCode: service identifier (e.g.,ecs,vpc)ServiceCn: Chinese name (e.g., "cloud server", "virtual private cloud")Product: product identifier (e.g.,ECS,VPC)RegionType:regionalorglobal
Match the most appropriate ServiceCode based on the user's description.
2b. Query version list (when the version is unknown)
GET https://api.volcengine.com/api/common/explorer/versions?ServiceCode={ServiceCode}Each version contains:
Version: version string (e.g.,2020-04-01)IsDefault:1indicates the default version
Prefer the version with IsDefault=1. If none is marked default, use the latest version.
2c. Query API list (when the specific API is unknown)
GET https://api.volcengine.com/api/common/explorer/apis?ServiceCode={ServiceCode}&Version={Version}&APIVersion={Version}The response groups APIs by category. Each API contains:
Action: API name (e.g.,DescribeInstances)NameCn: Chinese name (e.g., "Query instance list")ApiGroup: group name (e.g., "Instance", "Image")Description: functional descriptionUsageScenario: usage scenariosAttentions: constraints and caveats
Match user intent using Action, NameCn, and Description.
2d. Query API details (core step)
GET https://api.volcengine.com/api/common/explorer/api-swagger?ServiceCode={ServiceCode}&Version={Version}&APIVersion={Version}&ActionName={ActionName}Returns the full Swagger/OpenAPI specification for the API. Extract key information as follows.
HTTP Method
The key under paths["/{ActionName}"] (get or post) indicates the HTTP method.
Request Parameters
Parameter location depends on the HTTP method:
GET requests: parameters are in paths["/{ActionName}"].get.parameters. Each parameter includes:
name: parameter namerequired: whether it is requiredschema.type: data typeschema.description: parameter description (often contains enum values, conditional rules, and value ranges)schema.enum: allowed values (if any)schema.default: default value (if any)schema.example: example value (if any)
Arrays and nested objects in GET parameters use naming conventions:
- Arrays:
ParamName.N(N starts from 1), e.g.,InstanceIds.1,InstanceIds.2 - Nested objects:
Parent.Child, e.g.,TagFilters.N.Key,TagFilters.N.Values.N
POST requests: parameters are in paths["/{ActionName}"].post.requestBody.content["application/json"].schema, using JSON Schema:
properties: parameter definitions, keyed by namerequired: array of required parameter names
POST parameters often have nested structures that require recursive parsing:
type: object-> inspectpropertiesfor child parameterstype: array-> inspectitemsfor element structure$ref: "#/components/schemas/XxxObject"-> look up the definition incomponents.schemasand expand recursively
Present nested parameters in a tree structure:
- InstanceId (string, required): instance ID
- DatabasePrivileges (array, optional): database privilege list
- AccountName (string, required): account name
- AccountPrivilege (string, required): privilege type — enum: ReadWrite, ReadOnly, ...
- AccountPrivilegeDetail (string, optional): privilege detail, comma-separatedParameter Dependencies
Many parameters have conditional dependencies, typically described in the description field. Watch for:
- Conditionally required: e.g., "required when
EnableIpv6is true" - Mutually exclusive: e.g., "when
Ipv6CidrBlockis specified,Ipv6MaskLenis ignored" - Value constraints: e.g., "when
Ipv6Ispis BGP, only 56 is supported" - Prerequisites: e.g., "
TagFilters.N.Values.NrequiresTagFilters.N.Keyto be set first"
Highlight these dependencies in the answer to help users avoid misconfiguration.
Pagination Parameters
Volcengine APIs use two common pagination patterns, identifiable from the Swagger parameters:
- Token-based: uses
MaxResults(page size) +NextToken(continuation token). The response includesNextToken; an empty value means the last page. - Offset-based: uses
PageSize+PageNumber(orOffset/Limit). The response includesTotalCount.
Specify which pagination pattern the API uses, along with default values and upper limits.
Response Structure
The response schema is defined at paths["/{ActionName}"].{method}.responses["200"].content["application/json"].schema, and may reference components.schemas via $ref.
Key response information:
- Field names, types, and descriptions
- Enum fields and their possible values (e.g.,
Status: RUNNING / STOPPED / CREATING) - Nested object structures (e.g., fields within each item in an
Instancesarray)
The info.x-demo section also provides useful reference — responseDemo[0].Code shows the complete response structure with example values.
Request/Response Examples
In the info.x-demo array:
requestDemo[0].Code: request example (shows how parameters are filled)responseDemo[0].Code: response example (shows the full return structure with sample values)
These are official examples and highly valuable. Proactively include them in the answer.
Associated Error Codes
In paths["/{ActionName}"].{method}.responses["x-error-code"].content["application/json"].schema.oneOf, each error code contains:
code: error code identifier (e.g.,InvalidInstanceId.NotFound)http_code: HTTP status code (e.g., 400, 404, 409, 429, 500)message: English descriptiondescription: Chinese description
2e. Search APIs (quick lookup)
When the user describes a requirement in natural language, searching is often the fastest approach. This can be used alongside steps 2a–2c.
GET https://api.volcengine.com/api/common/search/all?Query={keyword}&Channel=apiSearch terms can be in Chinese or English. If one keyword yields poor results, try synonyms, different granularity, or English Action-name style (e.g., "DescribeXxx").
Each result contains:
BizInfo.Action: API nameBizInfo.ServiceCode: service identifierBizInfo.ServiceCn: service Chinese nameBizInfo.Version: versionHighlight: matched highlight text
After finding the target API, use step 2d to get full details.
Step 3: Handle Error Code Queries
Error code queries need special handling because the same error code (e.g., InvalidParameter) may appear across dozens of APIs with different meanings.
Common Error Code Categories
| Category | Common Patterns | Typical Cause |
|---|---|---|
| Parameter error | InvalidParameter, InvalidParameterValue, MissingParameter | Typo in parameter name, value outside enum range, missing required parameter |
| Resource not found | InvalidXxx.NotFound, ResourceNotFound | Wrong resource ID, resource in a different region, already deleted |
| Resource status | InvalidXxx.InvalidStatus, IncorrectInstanceStatus | Current resource state does not allow this operation (e.g., modifying config without stopping the instance) |
| Quota/limit | QuotaExceeded, LimitExceeded | Account quota or API rate limit exceeded |
| Permission denied | UnauthorizedOperation, Forbidden | IAM policy not authorized, sub-account lacks permissions |
| Throttling | Throttling, RequestLimitExceeded | API call rate too high — reduce request rate or use exponential backoff |
| Server error | InternalError, ServiceUnavailable | Temporary server-side issue, usually retryable |
| Resource conflict | ResourceInUse, DuplicateXxx, OperationConflict | Resource is in use or name already exists |
When the user provides a specific API name
Query the API Swagger via step 2d and locate the error code in x-error-code. This is the most accurate approach because the same error code can have different meanings across APIs.
Combine the description (Chinese) and message (English) fields to provide: 1. Error meaning 2. Specific trigger conditions in the context of this API 3. Troubleshooting steps and resolution suggestions
When the user provides only the error code
1. Ask for context first: ask which API triggered the error — this enables precise diagnosis. The same InvalidParameter means entirely different things in RunInstances vs. CreateVpc. 2. If the user provides a service name but no API name: infer the most likely API from the error pattern and context, then query its Swagger to confirm. 3. Fallback search: if the user cannot provide more context, use the error code search endpoint:
GET https://api.volcengine.com/api/common/search/all?Query={error_code}&Channel=error_codeEach result contains:
Type:error_codeBizInfo.ServiceCode: service identifierBizInfo.ServiceCn: service Chinese nameBizInfo.Version: versionURL: error code documentation linkHighlight: matched highlight text
Since the same error code appears across multiple services, results may be numerous. Filter by any context the user has provided (service name, operation type, scenario).
Step 4: Compose the Answer
Organize a clear, professional answer based on the question type. Core principle: center on the user's question — extract the information the user needs rather than dumping the entire Swagger.
Finding an API
1. Recommend the API and explain why 2. Briefly describe its functionality and use case 3. List core required parameters 4. If multiple candidates exist, compare their use cases and let the user choose
Querying Parameters
1. State the HTTP method (GET/POST) 2. Required parameters first: list with type, description, and enum values 3. Use tree structure for nested parameters, marking required/optional at each level 4. Parameter dependencies: highlight conditional requirements, mutual exclusions, and value constraints 5. Describe the pagination pattern and default values separately 6. Show the request example (from x-demo) 7. Group optional parameters by function (filters, sorting, advanced config) and list briefly
Querying Response Structure
1. List key return fields with type and description 2. Show all possible values for enum fields 3. Use tree structure for nested objects 4. Show the response example (from x-demo responseDemo)
Querying Error Codes
1. Error meaning (Chinese and English descriptions) 2. Error category (parameter error / resource not found / permission denied, etc.) 3. Common causes 4. Specific troubleshooting steps and resolution suggestions 5. For throttling errors, recommend a retry strategy
Browsing Service Capabilities
1. Organize the API list by ApiGroup 2. Show Action name + Chinese name + one-line description for each API 3. If there are many APIs, prioritize core/commonly-used ones
Comparing APIs
1. Describe the functional purpose of each API 2. Compare applicable scenarios 3. Compare parameter differences (which is simpler, which is more flexible) 4. Provide a usage recommendation
Query Efficiency Tips
- API name known: go directly to 2d — one step
- Service name known: 2b -> 2c -> 2d, or search in parallel via 2e
- Only a natural-language description: prefer 2e search — faster than browsing level by level
- Completely uncertain: combine 2a (service list) + 2e (keyword search)
- Error code lookup: if an API name is available, go to 2d; otherwise, ask the user for context first
Important Notes
- Always fetch the latest data from the API Explorer endpoints — Volcengine APIs are updated frequently, so do not rely on memory
- Match the answer language to the user's language (Chinese question -> Chinese answer, English -> English)
- If the user's description is ambiguous, list possible options and ask for confirmation rather than guessing
- If the user needs runnable SDK code, direct them to the
volcengine-sdk-generatorskill - If the user needs CLI-based operations, direct them to the
volcengine-cliskill - When presenting parameter information, enum values, conditional rules, and value ranges in the description field are the most valuable content — do not omit them
- If a network error occurs during queries, inform the user and suggest retrying later
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Related skills
FAQ
Where does this skill get its API information?
It queries the Volcengine API Explorer endpoints at api.volcengine.com for authoritative, up-to-date specs.
Can it generate SDK code?
No. For runnable SDK code it hands off to volcengine-sdk-generator; for CLI operations it hands off to volcengine-cli.