Skip to main content

Sync Background Agent

POST 
/api/background-agents/:id/sync

Syncs the agent to its platform. Creates or updates the agent definition there, uploads enabled skills, and stores fresh gateway credentials on the platform side. The dashboard calls this action Deploy; the endpoint keeps the older /sync name.

Syncing rotates the agent's secret internally, so any previously issued plaintext secret stops working.

Applies to platforms that keep an external copy of the agent, including willow-agents, claude-managed-agents, aws-agentcore, and custom types registered through Add custom type (custom-managed).

Request​

Responses​

Agent synced successfully