# Playbook Developers

> Official developer documentation for Playbook, the coder-friendly way to host, search, and ship visual files. Covers the REST API for creative asset management, the playbook-sdk for embedding a media library or portfolio, and the hosted MCP server for connecting AI assistants (Claude, Cursor, ChatGPT) to a Playbook workspace.


## Documentation


### Getting started

Start building with the Playbook API — the coder-friendly way to host, search, and ship your visual files. Authenticate, make your first call, and understand how organizations, boards, and assets fit together.

- [Getting Started](/docs/getting_started.md): Start building with the Playbook API — the coder-friendly way to host, search, and ship your visual files. Authenticate, make your first call, and understand how organizations, boards, and assets fit together.

### Examples

End-to-end examples for building real products on the Playbook API — portfolios, digital asset management, client galleries, brand portals, marketplaces, and AI media pipelines.

- [Examples](/docs/examples.md): End-to-end examples for building real products on the Playbook API — portfolios, digital asset management, client galleries, brand portals, marketplaces, and AI media pipelines.
- [AI media pipeline](/docs/examples/ai-pipeline.md): Build an AI media pipeline on the Playbook API — have agents search semantically, ingest generated variations in bulk, and auto-tag them, or skip code entirely with the hosted MCP server.
- [Brand portal](/docs/examples/brand-portal.md): Build a brand portal on the Playbook API — publish approved logos, fonts, and templates as an always-current, embeddable gallery with token-scoped access for partners.
- [Client gallery](/docs/examples/client-gallery.md): Build a client proofing gallery on the Playbook API — share a board of selects, collect feedback with comments, and deliver high-res downloads once the client approves.
- [Digital asset management](/docs/examples/digital-asset-management.md): Build a digital asset management (DAM) system on the Playbook API — define custom fields, ingest and tag assets, search by metadata, and keep downstream systems in sync with webhooks.
- [Creative marketplace](/docs/examples/marketplace.md): Build a creative marketplace on the Playbook API — accept seller uploads with signed URLs, power natural-language discovery with AI search, and deliver licensed originals on purchase.
- [Portfolio](/docs/examples/portfolio.md): Build an auto-updating portfolio on the Playbook API — create a board, add work, then publish it as a public web gallery or render your own with the board assets endpoint.

### Guides

- [AI-Powered Search](/docs/guides/ai_search.md): Search Playbook assets with natural language using AI Search — semantic, concept-aware retrieval that goes beyond keyword matching.
- [Advanced Asset Management](/docs/guides/asset_management.md): Organize a portfolio or media library programmatically — the Playbook API patterns for moving, batching, tagging, and curating visual files at scale.
- [Comments and Collaboration](/docs/guides/comments.md): Read, post, and manage threaded comments on Playbook assets and boards via the API for collaboration and review workflows.
- [Create Boards in an Organization](/docs/guides/create_boards.md): Create new boards inside a Playbook organization via the API, including required permissions, parameters, and example requests.
- [Custom Fields](/docs/guides/custom_fields.md): Add structured metadata to Playbook assets with custom fields — define schemas, predefined options, and update values via the API.
- [Fetching Data from the Playbook API](/docs/guides/fetching_data.md): Retrieve organizations, boards, and assets from Playbook with simple GET calls — authentication, pagination, and example responses.
- [Connect AI Assistants via MCP](/docs/guides/mcp.md): Connect Claude, Cursor, ChatGPT, and other MCP clients to Playbook so AI assistants can search, tag, upload, and manage your media via natural language.
- [Embed a Gallery with the SDK](/docs/guides/sdk.md): Embed a Playbook media gallery in your product with the playbook-sdk — install, initialize with your org slug and token, and customize columns, search, and events.
- [Search Assets in User's Organization](/docs/guides/search.md): Search Playbook assets across an organization by keyword, filters, and pagination using the v1 search endpoint.
- [Sharing and Publishing](/docs/guides/sharing_and_publishing.md): Share Playbook assets and boards privately with shared links, or publish boards as public web pages — full API reference and examples.
- [Uploading Assets to Playbook](/docs/guides/upload.md): Host your visual files in Playbook via API — upload from a public URL or via the two-step signed-upload flow, with endpoints, parameters, and complete examples.
- [Webhooks](/docs/guides/webhooks.md): Receive real-time webhook notifications when Playbook assets are added, updated, or deleted — set up triggers, payloads, and verification.

### API reference

Full REST API reference for Playbook, the media library and digital asset management (DAM) platform. Endpoints for assets, boards, search, sharing, custom fields, and webhooks, with an interactive request explorer and code samples in curl, Python, Node, and Ruby.

- [Playbook API Reference](/docs/api.md): Full REST API reference for Playbook, the media library and digital asset management (DAM) platform. Endpoints for assets, boards, search, sharing, custom fields, and webhooks, with an interactive request explorer and code samples in curl, Python, Node, and Ruby.
- [AI Search](/docs/api/ai-search-organization-assets.md): AI powered search through current organization's assets
- [List Asset Children](/docs/api/asset-children.md): Get children for asset if it is a group
- [List Asset Comments](/docs/api/asset-comments.md): Asset comments
- [Change Asset Tags](/docs/api/change-asset-tags.md): Updates asset tags
- [Check Organization Name](/docs/api/check-organization-name.md): Checks name availability for the new organization
- [List Board Assets](/docs/api/collection-assets.md): Get collection's assets
- [Copy Assets](/docs/api/copy-assets.md): Bulk copy assets to a different board (async operation)
- [Create Asset Permalinks](/docs/api/create-asset-permalinks.md): Creates permalinks for assets
- [Create Custom Field](/docs/api/create-custom-field.md): Creates new custom field
- [Create Organization](/docs/api/create-organization.md): Creates new organization
- [Create Webhook](/docs/api/create-trigger.md): Create a new webhook trigger.
- [Delete Asset Permalinks](/docs/api/delete-asset-permalinks.md): Deletes permalinks for assets
- [Delete Custom Field](/docs/api/delete-custom-field.md): Deletes custom field and all its options
- [Delete Webhook](/docs/api/delete-trigger.md): Delete a webhook trigger.
- [Delete User](/docs/api/delete-user.md): Delete user
- [Download Asset](/docs/api/download-asset.md): Get download links for asset
- [Download Shared Asset](/docs/api/download-shared-asset.md): Get download links for a shared asset
- [Get Organization](/docs/api/get-organization.md): Get info about one organization
- [Get Asset](/docs/api/get-organization-asset.md): Get info about one asset from organization
- [Get Board](/docs/api/get-organization-collection.md): Get info about one collection from organization
- [List Board Children](/docs/api/get-organization-collection-children.md): Get children of specific collection
- [List Board Comments](/docs/api/get-organization-collection-comments.md): Get collection comments
- [List Board Descendants](/docs/api/get-organization-collection-descendants.md): Get descendants of a specific board
- [Get User](/docs/api/get-user.md): Get info about one user
- [List User Favorites](/docs/api/get-user-favorites.md): Get info about user's favorites
- [List User Uploads](/docs/api/get-user-uploads.md): Get info about user's uploads
- [Group Assets](/docs/api/group-assets.md): Groups multiple assets together under a parent asset
- [List Users](/docs/api/list-users.md): Get list of users
- [Get Current User](/docs/api/me.md): Get current user's info
- [Move Assets](/docs/api/move-assets.md): Bulk move assets to a different board
- [List My Organizations](/docs/api/my-organizations.md): Get current user's organizations
- [Batch Create Assets From URLs](/docs/api/organization-asset-batch-create-from-urls.md): Creates up to 100 assets at once by ingesting their bytes from public URLs.
- [Batch Complete Upload](/docs/api/organization-asset-batch-upload-complete.md): **Final Step of Batch Asset Upload Process**
- [Batch Prepare Upload](/docs/api/organization-asset-batch-upload-prepare.md): **Step 1 of Batch Asset Upload Process**
- [Transform Assets](/docs/api/organization-asset-transform.md): Transform image assets using arbitraty params
- [Complete Upload](/docs/api/organization-asset-upload-complete.md): **Final Step of Asset Upload Process**
- [Prepare Upload](/docs/api/organization-asset-upload-prepare.md): **Step 1 of Asset Upload Process**
- [List Assets](/docs/api/organization-assets.md): Get current organization's assets
- [List Boards](/docs/api/organization-collections.md): Get current organization's boards
- [Create Asset](/docs/api/organization-create-asset.md): Creates new asset
- [Create Board](/docs/api/organization-create-collection.md): Creating new board in current organization
- [List Custom Fields](/docs/api/organization-custom-fields.md): Get current organization's custom fields
- [Delete Asset](/docs/api/organization-delete-asset.md): Deletes an asset from the organization
- [Delete Board](/docs/api/organization-destroy-collection.md): Destroys collection in current organization
- [Update Asset](/docs/api/organization-update-asset.md): Updates asset attributes (PUT also would work)
- [Update Board](/docs/api/organization-update-collection.md): Update board in current organization. PUT request also will work
- [Playbook API](/docs/api/playbook-api.md): The Playbook API lets you host, organize, search, and ship visual media: a
- [Publish Board](/docs/api/publish-organization-collection.md): Publish a board to the web
- [Search Assets](/docs/api/search-organization-assets.md): Search through current organization's assets
- [Share Asset](/docs/api/share-organization-asset.md): Creates a Shared link with asset
- [Share Board](/docs/api/share-organization-collection.md): Create a Shared link for a board
- [Track Downloads](/docs/api/track-download-on-organization.md): Tracks a download
- [Ungroup Assets](/docs/api/ungroup-assets.md): Removes assets from their groups, making them individual assets again
- [Update Asset Status](/docs/api/update-asset-status.md): Updates asset status

### conventions

How the Playbook API behaves across every endpoint. Base URL, Bearer auth and scopes, the data response envelope, status codes, rate limiting, pagination, and async ingest. One ground-truth reference for developers and AI agents.

- [API Conventions](/docs/conventions.md): How the Playbook API behaves across every endpoint. Base URL, Bearer auth and scopes, the data response envelope, status codes, rate limiting, pagination, and async ingest. One ground-truth reference for developers and AI agents.

## Optional
- [Playbook product overview (llms.txt)](https://www.playbook.com/llms.txt): Product-level LLM index for playbook.com: pricing, use cases, and platform overview.