SignalShelf · Developer documentation

Connect SignalShelf to your workflow

SignalShelf integrations are built around one authenticated API. Use the same account, source availability, cache rules, and credit controls from your app, agent, or automation.

Start with the HTTP API

Any client that can send HTTPS requests can call SignalShelf. Set your deployment origin as the base URL and send your API key in the x-api-key header. Use /api/openapi.compatibility.json for catalog-mapped operations or /api/openapi.json for the full SignalShelf contract. Import either contract into an OpenAPI-compatible tool.

EXAMPLE
POST https://signalshelf.dev/api/v1/profiles
Content-Type: application/json
x-api-key: YOUR_SERVER_SIDE_KEY

{"platform":"bluesky","handle":"bsky.app","mode":"demo","freshness":"24h"}
Read the API quickstart Open the compatibility API contract Open the full OpenAPI contract

Connect an MCP client

SignalShelf provides a stateless Streamable HTTP MCP endpoint at https://signalshelf.dev/mcp. Configure your client with that URL and a secret x-api-key header. The server exposes tools for profile lookups, batches, supported GitHub, Bluesky, YouTube and Apple Music catalog resources, capabilities, credits, and account usage. Use demo mode first; live lookups can spend credits.

MCP setup and supported tools

Give a coding agent a first-party skill

Download the creator research skill to guide public-profile comparisons, or the API integration skill to help an agent build against your own SignalShelf deployment. Set the base URL and API key in the agent environment or secret store. Skills describe existing APIs; they do not add unsupported extraction operations.

Creator research skill API integration skill Skill installation guide

Use workflow automation tools

In n8n or another workflow builder, use its generic HTTP Request step: POST to /api/v1/profiles, set Content-Type to application/json, store x-api-key as a secret credential, and send the JSON body shown above. This is a standard HTTP integration, not a SignalShelf-maintained n8n node. The same pattern works in serverless functions, queues, scripts, and other HTTP-capable services.

EXAMPLE
Method: POST
URL: {{$env.SIGNALSHELF_BASE_URL}}/api/v1/profiles
Headers:
  Content-Type: application/json
  x-api-key: (read from a secret credential)
Body (JSON):
  {"platform":"bluesky","handle":"bsky.app","mode":"demo","freshness":"24h"}
API key and authentication guidance

Choose demo, cache, and live behavior deliberately

Demo mode returns clearly labeled illustrative data and costs zero credits. A fresh successful live lookup costs one credit. An accepted cached result and a failed lookup cost zero. Set freshness to live, 1h, 24h, or 7d and inspect the response metadata to see whether a cache entry was used and how many credits were charged.

Caching and credit rules Current platform and operation coverage

Connect an Instagram professional account you manage

The workspace Connections page can connect an Instagram professional account linked to a Facebook Page you manage. Facebook Login requests pages_show_list, instagram_basic, and pages_read_engagement. Meta app review and external-user access are required before other SignalShelf users can authorize the integration.

The Instagram tagged-posts compatibility route only reads the account connected by the same SignalShelf user. Its user_id must match that account. It does not fetch arbitrary public handles, personal consumer accounts, or private data. This route has local simulation evidence only; live source behavior and commercial redistribution remain unverified, and production access stays disabled.

Check endpoint status and limits Read the compatibility API contract

Integration availability

Available now: HTTP API, machine-readable OpenAPI, stateless MCP, and two downloadable first-party skills. Generic HTTP nodes can connect workflow builders such as n8n without a custom node. SignalShelf does not currently publish a native CLI, official SDK packages, a maintained Postman collection, a dedicated n8n node, or Apify actors. We will document those here if they become available.

Explore the API in your workspace. Sample results and accepted cache hits cost zero credits. Open the playground →