Dreamstate API reference

Developer reference for the Dreamstate REST API, including workspace authentication, outreach campaigns, content publishing, AI visibility, and reporting endpoints.

What the API supports

The Dreamstate API is the programmatic surface for teams that want to connect growth workflows to external systems. It is designed around authenticated workspace operations rather than anonymous public actions.

Use it for integrations that need to create or read campaigns, coordinate outreach work, publish or inspect content, and connect AI visibility reporting to a broader operating system.

Authentication model

  • Use a scoped workspace API key or authenticated backend token.
  • Keep keys server-side and avoid exposing them in browser JavaScript.
  • Scope automation to the workspace and account that owns the content, outreach, or reporting workflow.

Common endpoint families

  • Outreach and campaign workflow endpoints.
  • Content, publishing, scheduling, and post state endpoints.
  • AI visibility, crawler attribution, source citation, and reporting endpoints.
  • Workspace, destination, and integration configuration endpoints.

Implementation notes

Prefer idempotent writes for background jobs, store provider IDs returned by Dreamstate, and retry only when the API response indicates the request is safe to repeat. For user-facing workflows, show the pending state and reconcile against the backend instead of assuming a publish or outreach action completed immediately.

Production integrations should log the Dreamstate workspace ID, external provider ID, request ID, and final state transition. That makes it possible to debug a scheduled post, outreach action, source ingestion job, or AI visibility report without guessing which system changed the record last.

For security, keep API keys on the server, rotate credentials when an agency or contractor leaves a workspace, and avoid mixing customer workspaces in one automation job. Dreamstate APIs are designed around workspace-scoped operations, so the safest integration pattern is one explicit workspace context per request.