bam-api

Query BAM API definitions, endpoint lists, and versions, and create new service versions by PSM.

Updated Apr 30, 2026
One-click install
npx skills add https://github.com/yuezhen-huang/my-bytedance-skillhub --skill bam-api-yuezhen-huang
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bam-api
Source: https://github.com/yuezhen-huang/my-bytedance-skillhub/tree/main/bam-api
Command: npx skills add https://github.com/yuezhen-huang/my-bytedance-skillhub --skill bam-api-yuezhen-huang

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Engineers often need to look up what APIs a service exposes, inspect interface definitions, or publish a new BAM version, but doing this manually through the BAM platform is slow and error-prone. This Skill lets you query API metadata and manage versions directly through gdpa-cli commands. ## Core Features & Use Cases - API Definition Lookup: Retrieve interface definitions by PSM plus method name, path, endpoint ID, or free-text keyword, with optional version, branch, and region filters. - Service & Version Listing: List all endpoints of a PSM or browse its published version history, including i18n region support. - Version Creation: Create a new BAM version for a PSM and branch, automatically incrementing the latest version number and pulling the latest git commit. - Use Case: You need to check the request/response schema of GetUserInfo on tiktok.user.service before integrating it, then publish version 1.0.62 from the master branch after your change merges. ## Quick Start Ask the agent to look up the API definition of a specific method on a given PSM, for example: show me the interface definition of GetUserInfo on tiktok.user.service.

Frequently Asked Questions about bam-api

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I look up an API definition on BAM by method name?

Use the get_api_definition_info action with the psm and method parameters, for example psm tiktok.user.service and method GetUserInfo. You can optionally filter by version, branch, and region to narrow the result.

How to find a BAM interface when I only know the endpoint ID?

Use get_api_definition_info_with_endpoint_id with the endpointId parameter, which is the recommended lookup method when the ID is known. Version, branch, and region are optional filters.

Can I search BAM APIs without knowing the PSM?

Yes, use get_api_definition_info_without_psm with a keyword matching the method name or path. It supports pagination via offset and count, and an ep_type filter for http or rpc interfaces.

How do I create a new BAM version for a service?

Call create_service_version with the psm and branch; it automatically increments the latest version number and pulls the newest git commit. You must confirm the psm, branch, and target version with the user first, and be logged in via gdpa-cli login.

Does BAM API query support international region services?

Yes, pass region set to i18n on any query action to look up interfaces or versions for international services. The default region is cn for domestic services.

What is the difference between bam-api and bam-query?

bam-api reads API metadata and manages versions, such as definitions, endpoint lists, and version creation. bam-query is for sending actual requests to interfaces, so use bam-api for documentation lookup and bam-query for live invocation.