| get_swipes | Get swipes from your swipe file.
Args:
api_key: Your SwipeBuilder API key (sb_live_xxx or sb_test_xxx).
Optional if SWIPEBUILDER_API_KEY env var is set.
platform: Filter by platform (facebook, tiktok, instagram, linkedin, google)
format: Filter by format (image, video, carousel)
limit: Number of results (1-100, default 50)
cursor: Pagination cursor from previous response
Returns:
Dictionary with swipes data, pagination info, and credit usage
Credit Usage: 1 credit per swipe returned
|
| get_swipe | Get a single swipe by ID.
Args:
swipe_id: The ID of the swipe to retrieve
api_key: Your SwipeBuilder API key. Optional if SWIPEBUILDER_API_KEY env var is set.
Returns:
Dictionary with swipe data or error message
Credit Usage: 1 credit
|
| get_collections | Get your collections (folders).
Args:
api_key: Your SwipeBuilder API key. Optional if SWIPEBUILDER_API_KEY env var is set.
parent_id: Filter by parent ('root' for root-level, collection ID for children, None for all)
limit: Number of results (1-100, default 50)
cursor: Pagination cursor from previous response
Returns:
Dictionary with collections data and pagination info
Credit Usage: No credits consumed
|
| get_collection | Get a single collection by ID.
Args:
collection_id: The ID of the collection to retrieve
api_key: Your SwipeBuilder API key. Optional if SWIPEBUILDER_API_KEY env var is set.
Returns:
Dictionary with collection data or error message
Credit Usage: No credits consumed
|
| get_collection_items | Get items (swipes) in a collection.
Args:
collection_id: The ID of the collection
api_key: Your SwipeBuilder API key. Optional if SWIPEBUILDER_API_KEY env var is set.
limit: Number of results (1-100, default 50)
cursor: Pagination cursor from previous response
Returns:
Dictionary with collection info, items data, and pagination
Credit Usage: 1 credit per swipe returned
|
| get_usage | Get your API credit usage for the current month.
Args:
api_key: Your SwipeBuilder API key. Optional if SWIPEBUILDER_API_KEY env var is set.
Returns:
Dictionary with usage statistics including:
- credits_used: Credits consumed this month
- credits_limit: Monthly credit limit
- credits_remaining: Credits still available
- period_start: Start of billing period
- period_end: End of billing period
Credit Usage: No credits consumed
|
