Build on HipDeck
Connect workspace tools and AI agents to discover content, create and edit playlist drafts, monitor displays, and safely update screen assignments.
Create an API keyConnect an AI agent with MCPGetting started
Create a workspace-scoped key from Workspace → Developers. The secret is shown once, so store it securely. Send it with every request as a bearer credential.
Authorization: Bearer hd_live_<prefix>.<secret>
Connect an AI agent with MCP
HipDeck also provides a workspace-scoped MCP server at https://api.hipdeck.co/mcp. Add it as a custom connector or app in a ChatGPT workspace with MCP developer mode enabled, select Streamable HTTP, and configure the complete API key as bearer authentication. ChatGPT does not automatically discover public MCP servers; the custom connector controls may require a supported plan or workspace administrator approval.
Endpoints
Authentication
Example request
GET /api/v1/me HTTP/1.1 Host: api.hipdeck.co Authorization: Bearer hd_live_<prefix>.<secret>
Example response
{
"data": {
"type": "public_api_principal",
"id": "api-key-id",
"attributes": {
"name": "Production integration",
"workspaceId": "42",
"scopes": [
"workspaces:read"
],
"environment": "live"
}
}
}Screens
Content
Test the API
Requests go directly to the selected API host. Your key stays in this browser tab and is not stored.
Authorization and safety
Keys are restricted to one workspace and only the scopes selected when the key is created. Workspace IDs in request paths must match the key.
Discovery scopes
Collection endpoints use cursor pagination with a default limit of 25 and maximum of 100. Playlist read responses expose published content only. Playlist write requests use a versioned canonical document and update drafts without publishing them.
