API

When to use: How to use the OutboundSync API, what your key can access, which endpoint to call, OpenAPI discovery, account vs connection keys, or how API work relates to Preflight and Sync monitoring.

What it does

The api skill is the umbrella guide for OutboundSync API v1. It explains auth and scopes, the Sources / destinations / Sync Monitoring vocabulary, and routes deep workflows to specialized skills. It may run light introspection (/me, connections, Sources, account status, reply-relays). It does not run the full launch gauge (that’s Preflight) and does not mutate Sync Monitoring webhooks (that’s Sync monitoring, with confirmation).

Live OpenAPI may lag some routes — the skill documents the gap and prefers the API v1 reference.

Try saying this

You have an API key and want the right calls

You

❯ What can my OutboundSync API key access, and which skill should I use for Sync Monitoring?

Agent ◆ Skill · api

I’ll call /me, map Sources vs Sync Monitoring vocabulary, and hand you off to preflight or sync-monitoring — I won’t mutate webhooks from this skill.

What you’ll get

• Intent and key scope summary
• Which vocabulary applies (Sources vs Sync Monitoring, etc.)
• Ordered calls or a clear hand-off to another skill
• Cautions on secrets and incomplete OpenAPI when relevant

Get started

1. Put an OutboundSync API key in $OUTBOUNDSYNC_API_KEY (Creating API keys · Install).
2. Install the skill:

npx skills add outboundsync/skills --skill api -g

Full procedure: skills/api/.