Spacefast API

Publish files as a Space, then manage Spaces, versions, builds, domains, and teams. Every operation a person can run in the dashboard is here, for people and for agents.

Every path is versioned under /v1. A successful response wraps its payload in { data }. An error is an RFC 9457 problem document served as application/problem+json with a stable code.

A deprecated operation also sends Deprecation (RFC 9745) and Sunset (RFC 8594) headers and a Link with rel="deprecation" to the policy: https://spacefast.com/docs/api/versioning

Version 0.3.0

Base URL https://api.spacefast.com

Spaces

Create, update, transfer, and delete Spaces.

• POST /v1/abuse-reports
• POST /v1/beta/accept
• POST /v1/beta/signups
• GET /v1/beta/visitor
• POST /v1/feedback
• GET /v1/operation-reads/{capability}
• GET /v1/slugs/availability
• GET /v1/space-transfers
• POST /v1/space-transfers
• GET /v1/space-transfers/{transferId}
• DELETE /v1/space-transfers/{transferId}
• POST /v1/space-transfers/{transferId}/accept
• GET /v1/spaces
• POST /v1/spaces
• GET /v1/spaces/resolve
• GET /v1/spaces/{spaceId}
• DELETE /v1/spaces/{spaceId}
• PATCH /v1/spaces/{spaceId}
• GET /v1/spaces/{spaceId}/access-requests
• POST /v1/spaces/{spaceId}/access-requests/{requestId}/approve
• POST /v1/spaces/{spaceId}/access-requests/{requestId}/deny
• POST /v1/spaces/{spaceId}/apply
• GET /v1/spaces/{spaceId}/apply-state
• GET /v1/spaces/{spaceId}/channels
• PATCH /v1/spaces/{spaceId}/channels/{name}
• GET /v1/spaces/{spaceId}/channels/{name}/history
• POST /v1/spaces/{spaceId}/claim-reminders
• GET /v1/spaces/{spaceId}/collaboration
• PATCH /v1/spaces/{spaceId}/collaboration
• POST /v1/spaces/{spaceId}/collaboration/notify-email
• GET /v1/spaces/{spaceId}/comments
• GET /v1/spaces/{spaceId}/comments/embed-config
• POST /v1/spaces/{spaceId}/comments/embed-ticket
• GET /v1/spaces/{spaceId}/comments/export
• GET /v1/spaces/{spaceId}/comments/{threadId}
• PATCH /v1/spaces/{spaceId}/comments/{threadId}
• POST /v1/spaces/{spaceId}/comments/{threadId}/reactions
• POST /v1/spaces/{spaceId}/comments/{threadId}/read
• POST /v1/spaces/{spaceId}/comments/{threadId}/replies
• POST /v1/spaces/{spaceId}/content/admin-session
• POST /v1/spaces/{spaceId}/content/sync/acknowledge
• POST /v1/spaces/{spaceId}/content/sync/reconcile
• GET /v1/spaces/{spaceId}/crons
• GET /v1/spaces/{spaceId}/data-sources
• GET /v1/spaces/{spaceId}/files
• GET /v1/spaces/{spaceId}/grants
• POST /v1/spaces/{spaceId}/grants
• GET /v1/spaces/{spaceId}/grants/check
• PUT /v1/spaces/{spaceId}/grants/{grantId}
• DELETE /v1/spaces/{spaceId}/grants/{grantId}
• GET /v1/spaces/{spaceId}/machine-credentials
• POST /v1/spaces/{spaceId}/machine-credentials
• DELETE /v1/spaces/{spaceId}/machine-credentials/{credentialId}
• POST /v1/spaces/{spaceId}/machine-credentials/{credentialId}/rotate
• POST /v1/spaces/{spaceId}/open
• GET /v1/spaces/{spaceId}/password-credentials
• POST /v1/spaces/{spaceId}/password-credentials
• DELETE /v1/spaces/{spaceId}/password-credentials/{credentialId}
• POST /v1/spaces/{spaceId}/password-credentials/{credentialId}/rotate
• GET /v1/spaces/{spaceId}/people
• POST /v1/spaces/{spaceId}/people
• DELETE /v1/spaces/{spaceId}/people/{personId}
• POST /v1/spaces/{spaceId}/people/{personId}/resend
• PUT /v1/spaces/{spaceId}/people/{personId}/roles
• GET /v1/spaces/{spaceId}/plan-policy
• POST /v1/spaces/{spaceId}/realtime/token
• POST /v1/spaces/{spaceId}/restore
• GET /v1/spaces/{spaceId}/routing/compute
• GET /v1/spaces/{spaceId}/share-links
• POST /v1/spaces/{spaceId}/share-links
• DELETE /v1/spaces/{spaceId}/share-links/{linkId}
• PATCH /v1/spaces/{spaceId}/share-links/{linkId}
• POST /v1/spaces/{spaceId}/share-links/{linkId}/frame-session
• POST /v1/spaces/{spaceId}/share-links/{linkId}/frame-session/renew
• POST /v1/spaces/{spaceId}/sharing/logout-all
• GET /v1/spaces/{spaceId}/storage
• POST /v1/spaces/{spaceId}/storage
• DELETE /v1/spaces/{spaceId}/storage/{objectId}
• PUT /v1/spaces/{spaceId}/uploads/{uploadId}
• GET /v1/spaces/{spaceId}/usage
• POST /v1/spaces/{spaceId}/wp-cli
• GET /v1/spaces/{spaceId}/zero/abilities
• GET /v1/spaces/{spaceId}/zero/content-model
• POST /v1/spaces/{spaceId}/zero/token

Agent

What an agent can do with its credential: context, approvals, and resuming a paused action.

• POST /v1/actions/resume
• GET /v1/approvals
• POST /v1/approvals
• GET /v1/approvals/{approvalId}
• POST /v1/approvals/{approvalId}/approve
• POST /v1/approvals/{approvalId}/deny
• GET /v1/context

Activity

Activity feeds, logs, analytics, webhooks, and background operations.

• GET /v1/activity
• GET /v1/operations
• GET /v1/operations/{operationId}
• GET /v1/spaces/{spaceId}/activity
• GET /v1/spaces/{spaceId}/analytics
• GET /v1/spaces/{spaceId}/diagnostics
• GET /v1/spaces/{spaceId}/logs
• GET /v1/spaces/{spaceId}/logs/access
• GET /v1/spaces/{spaceId}/logs/runtime
• GET /v1/teams/{teamId}/activity
• GET /v1/webhooks
• POST /v1/webhooks
• GET /v1/webhooks/{webhookId}
• DELETE /v1/webhooks/{webhookId}
• PATCH /v1/webhooks/{webhookId}
• GET /v1/webhooks/{webhookId}/deliveries
• GET /v1/webhooks/{webhookId}/deliveries/{deliveryId}
• POST /v1/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver
• POST /v1/webhooks/{webhookId}/rotate

Account

The signed-in account: identity, emails, API keys, device login, notifications, and event intake.

• GET /v1/api-keys
• POST /v1/api-keys
• GET /v1/api-keys/{apiKeyId}
• DELETE /v1/api-keys/{apiKeyId}
• PATCH /v1/api-keys/{apiKeyId}
• GET /v1/auth/device
• POST /v1/auth/device
• POST /v1/auth/device/approve
• POST /v1/auth/device/deny
• POST /v1/auth/device/poll
• GET /v1/auth/emails
• POST /v1/auth/emails
• POST /v1/auth/emails/verify
• DELETE /v1/auth/emails/{emailId}
• POST /v1/auth/emails/{emailId}/primary
• GET /v1/auth/methods
• POST /v1/auth/password
• GET /v1/bootstrap
• POST /v1/events
• GET /v1/me
• PATCH /v1/me/dashboard-preferences
• GET /v1/me/email-preferences
• PUT /v1/me/email-preferences
• GET /v1/me/grants
• DELETE /v1/me/grants
• GET /v1/me/grants/{grantId}
• DELETE /v1/me/grants/{grantId}
• GET /v1/me/grants/{grantId}/activity
• PATCH /v1/me/privacy
• GET /v1/notifications
• POST /v1/notifications/read
• GET /v1/notifications/unread-count

Connectors

Services a team connected, the tools they expose, what policy allows, and the runs and artifacts built on them.

• GET /v1/artifacts
• POST /v1/artifacts
• GET /v1/artifacts/{ref}
• DELETE /v1/artifacts/{ref}
• PATCH /v1/artifacts/{ref}
• POST /v1/artifacts/{ref}/edits
• GET /v1/artifacts/{ref}/preview
• PUT /v1/artifacts/{ref}/preview
• GET /v1/connectors
• POST /v1/connectors
• GET /v1/connectors/catalog
• GET /v1/connectors/catalog/logo/{domain}
• GET /v1/connectors/catalog/{domain}/guidance
• GET /v1/connectors/connections
• POST /v1/connectors/connections
• POST /v1/connectors/connections/complete
• GET /v1/connectors/connections/{connectionId}
• PATCH /v1/connectors/connections/{connectionId}
• POST /v1/connectors/connections/{connectionId}/disconnect
• POST /v1/connectors/connections/{connectionId}/health
• POST /v1/connectors/connections/{connectionId}/refresh
• GET /v1/connectors/connections/{connectionId}/tools
• POST /v1/connectors/detect
• GET /v1/connectors/policies
• POST /v1/connectors/policies
• GET /v1/connectors/policies/resolve
• DELETE /v1/connectors/policies/{policyRuleId}
• PATCH /v1/connectors/policies/{policyRuleId}
• GET /v1/connectors/runs
• POST /v1/connectors/runs
• GET /v1/connectors/runs/{runId}
• POST /v1/connectors/runs/{runId}/resume
• GET /v1/connectors/{connectorRef}
• DELETE /v1/connectors/{connectorRef}
• PATCH /v1/connectors/{connectorRef}
• GET /v1/connectors/{connectorRef}/tools

Builds

Builds that turn source into a version: start, watch, retry, and cancel.

• GET /v1/builds/{buildId}
• POST /v1/builds/{buildId}/cancel
• GET /v1/builds/{buildId}/events
• GET /v1/builds/{buildId}/logs
• GET /v1/builds/{buildId}/receipt
• POST /v1/builds/{buildId}/retry
• POST /v1/builds/{buildId}/uploads/refresh
• GET /v1/spaces/{spaceId}/builds
• POST /v1/spaces/{spaceId}/builds
• GET /v1/spaces/{spaceId}/builds/preflight

Publishing

Publish files in one call and claim the Space it created.

• POST /v1/claim
• POST /v1/claim/exchange
• POST /v1/claim/rotate
• GET /v1/claim/status
• POST /v1/publish

Docs

The documentation as JSON: index, pages, search, and Ask.

• GET /v1/docs
• POST /v1/docs/ask
• GET /v1/docs/pages/{slug}
• GET /v1/docs/search

Domains

Domains: inventory, DNS, verification, and which Space each one serves.

• GET /v1/domains
• POST /v1/domains
• GET /v1/domains/preflight
• GET /v1/domains/{domainId}
• DELETE /v1/domains/{domainId}
• PATCH /v1/domains/{domainId}
• GET /v1/domains/{domainId}/diagnostics
• POST /v1/domains/{domainId}/ssl/retry
• POST /v1/domains/{domainId}/verify
• GET /v1/managed-domains
• GET /v1/spaces/{spaceId}/domains
• POST /v1/spaces/{spaceId}/domains

Git

Repositories connected to a Space: files, commits, diffs, branches, and syncs.

• GET /v1/repository-connections/installations
• GET /v1/repository-connections/installations/{installationId}/repositories
• GET /v1/spaces/{spaceId}/source/archive
• GET /v1/spaces/{spaceId}/source/blame
• GET /v1/spaces/{spaceId}/source/branches
• POST /v1/spaces/{spaceId}/source/branches
• DELETE /v1/spaces/{spaceId}/source/branches
• GET /v1/spaces/{spaceId}/source/commit
• GET /v1/spaces/{spaceId}/source/commit-diff
• GET /v1/spaces/{spaceId}/source/commits
• POST /v1/spaces/{spaceId}/source/commits
• POST /v1/spaces/{spaceId}/source/commits/diff
• GET /v1/spaces/{spaceId}/source/connection
• POST /v1/spaces/{spaceId}/source/connection
• DELETE /v1/spaces/{spaceId}/source/connection
• PATCH /v1/spaces/{spaceId}/source/connection
• POST /v1/spaces/{spaceId}/source/connection/analyze
• GET /v1/spaces/{spaceId}/source/connection/webhook-deliveries
• GET /v1/spaces/{spaceId}/source/connection/webhook-deliveries/{deliveryId}
• GET /v1/spaces/{spaceId}/source/diff
• POST /v1/spaces/{spaceId}/source/ephemeral-branch
• DELETE /v1/spaces/{spaceId}/source/ephemeral-branch
• POST /v1/spaces/{spaceId}/source/ephemeral-remote
• GET /v1/spaces/{spaceId}/source/file
• GET /v1/spaces/{spaceId}/source/files
• POST /v1/spaces/{spaceId}/source/import-remote
• POST /v1/spaces/{spaceId}/source/merge
• GET /v1/spaces/{spaceId}/source/notes
• POST /v1/spaces/{spaceId}/source/notes
• DELETE /v1/spaces/{spaceId}/source/notes
• GET /v1/spaces/{spaceId}/source/notes/refs
• POST /v1/spaces/{spaceId}/source/push-remote
• GET /v1/spaces/{spaceId}/source/search
• POST /v1/spaces/{spaceId}/source/sync
• GET /v1/spaces/{spaceId}/source/tags
• POST /v1/spaces/{spaceId}/source/tags
• DELETE /v1/spaces/{spaceId}/source/tags
• GET /v1/spaces/{spaceId}/source/workspaces
• POST /v1/spaces/{spaceId}/source/workspaces
• GET /v1/spaces/{spaceId}/source/workspaces/{workspaceId}
• POST /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/close
• POST /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/commit
• GET /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/conflicts
• GET /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/diff
• POST /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/files
• POST /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/resolve-conflicts
• POST /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/restore
• POST /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/stage
• POST /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/sync
• POST /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/undo
• POST /v1/spaces/{spaceId}/source/workspaces/{workspaceId}/unstage

Database

The database behind a Space’s runtime: schema, rows, migrations, and console.

• GET /v1/spaces/{spaceId}/db
• POST /v1/spaces/{spaceId}/db/console
• GET /v1/spaces/{spaceId}/db/dump
• GET /v1/spaces/{spaceId}/db/export
• GET /v1/spaces/{spaceId}/db/export/{table}
• POST /v1/spaces/{spaceId}/db/migrate

Runtime

What a Space runs: runtime status, the served shape, and realtime replay.

• GET /v1/spaces/{spaceId}/runtime
• GET /v1/spaces/{spaceId}/runtime/realtime/events

Tags

Tag templates, drafts, releases, and preview sessions.

• GET /v1/spaces/{spaceId}/tags
• GET /v1/spaces/{spaceId}/tags/activity
• POST /v1/spaces/{spaceId}/tags/apply
• GET /v1/spaces/{spaceId}/tags/consent-policy
• POST /v1/spaces/{spaceId}/tags/debug
• GET /v1/spaces/{spaceId}/tags/effective
• GET /v1/spaces/{spaceId}/tags/effective/{tagId}
• GET /v1/spaces/{spaceId}/tags/inheritance
• PATCH /v1/spaces/{spaceId}/tags/inheritance
• GET /v1/spaces/{spaceId}/tags/releases
• GET /v1/spaces/{spaceId}/tags/releases/{environment}
• PUT /v1/spaces/{spaceId}/tags/releases/{environment}
• POST /v1/spaces/{spaceId}/tags/releases/{environment}/rollback
• GET /v1/spaces/{spaceId}/tags/revisions
• POST /v1/spaces/{spaceId}/tags/revisions
• GET /v1/spaces/{spaceId}/tags/revisions/{revisionId}
• PATCH /v1/spaces/{spaceId}/tags/revisions/{revisionId}
• POST /v1/spaces/{spaceId}/tags/revisions/{revisionId}/abandon
• POST /v1/spaces/{spaceId}/tags/revisions/{revisionId}/approve
• GET /v1/spaces/{spaceId}/tags/revisions/{revisionId}/diff
• GET /v1/spaces/{spaceId}/tags/revisions/{revisionId}/graph
• PUT /v1/spaces/{spaceId}/tags/revisions/{revisionId}/graph
• PATCH /v1/spaces/{spaceId}/tags/revisions/{revisionId}/graph
• GET /v1/spaces/{spaceId}/tags/revisions/{revisionId}/preview-sessions
• POST /v1/spaces/{spaceId}/tags/revisions/{revisionId}/preview-sessions
• GET /v1/spaces/{spaceId}/tags/revisions/{revisionId}/preview-sessions/{sessionId}
• DELETE /v1/spaces/{spaceId}/tags/revisions/{revisionId}/preview-sessions/{sessionId}
• POST /v1/spaces/{spaceId}/tags/revisions/{revisionId}/submit
• POST /v1/spaces/{spaceId}/tags/revisions/{revisionId}/validate
• GET /v1/spaces/{spaceId}/tags/templates
• GET /v1/tags/templates
• GET /v1/teams/{teamId}/tags/activity
• POST /v1/teams/{teamId}/tags/apply
• GET /v1/teams/{teamId}/tags/releases
• GET /v1/teams/{teamId}/tags/releases/{environment}
• PUT /v1/teams/{teamId}/tags/releases/{environment}
• POST /v1/teams/{teamId}/tags/releases/{environment}/rollback
• GET /v1/teams/{teamId}/tags/revisions
• POST /v1/teams/{teamId}/tags/revisions
• GET /v1/teams/{teamId}/tags/revisions/{revisionId}
• PATCH /v1/teams/{teamId}/tags/revisions/{revisionId}
• POST /v1/teams/{teamId}/tags/revisions/{revisionId}/abandon
• POST /v1/teams/{teamId}/tags/revisions/{revisionId}/approve
• GET /v1/teams/{teamId}/tags/revisions/{revisionId}/diff
• GET /v1/teams/{teamId}/tags/revisions/{revisionId}/graph
• PUT /v1/teams/{teamId}/tags/revisions/{revisionId}/graph
• PATCH /v1/teams/{teamId}/tags/revisions/{revisionId}/graph
• GET /v1/teams/{teamId}/tags/revisions/{revisionId}/preview-sessions
• POST /v1/teams/{teamId}/tags/revisions/{revisionId}/preview-sessions
• GET /v1/teams/{teamId}/tags/revisions/{revisionId}/preview-sessions/{sessionId}
• DELETE /v1/teams/{teamId}/tags/revisions/{revisionId}/preview-sessions/{sessionId}
• POST /v1/teams/{teamId}/tags/revisions/{revisionId}/submit
• POST /v1/teams/{teamId}/tags/revisions/{revisionId}/validate
• GET /v1/teams/{teamId}/tags/templates

Variables

Variables on a Space or team, resolved when a version publishes.

• GET /v1/spaces/{spaceId}/variables
• PUT /v1/spaces/{spaceId}/variables/{name}
• DELETE /v1/spaces/{spaceId}/variables/{name}
• GET /v1/teams/{teamId}/variables
• PUT /v1/teams/{teamId}/variables/{name}
• DELETE /v1/teams/{teamId}/variables/{name}

Versions

Versions of a Space: upload, finalize, promote, and inspect.

• GET /v1/spaces/{spaceId}/versions
• POST /v1/spaces/{spaceId}/versions
• GET /v1/spaces/{spaceId}/versions/compare
• GET /v1/spaces/{spaceId}/versions/{versionId}
• DELETE /v1/spaces/{spaceId}/versions/{versionId}
• GET /v1/spaces/{spaceId}/versions/{versionId}/comments
• POST /v1/spaces/{spaceId}/versions/{versionId}/comments
• GET /v1/spaces/{spaceId}/versions/{versionId}/comments/export
• GET /v1/spaces/{spaceId}/versions/{versionId}/convention-artifacts
• GET /v1/spaces/{spaceId}/versions/{versionId}/convention-artifacts/content
• GET /v1/spaces/{spaceId}/versions/{versionId}/files
• GET /v1/spaces/{spaceId}/versions/{versionId}/files/links
• POST /v1/spaces/{spaceId}/versions/{versionId}/finalize
• GET /v1/spaces/{spaceId}/versions/{versionId}/logs
• POST /v1/spaces/{spaceId}/versions/{versionId}/preview-session
• POST /v1/spaces/{spaceId}/versions/{versionId}/promote
• GET /v1/spaces/{spaceId}/versions/{versionId}/routing-summary
• POST /v1/spaces/{spaceId}/versions/{versionId}/uploads/refresh

Teams

Teams: membership, settings, usage, and entitlements.

• GET /v1/team-invitations
• POST /v1/team-invitations
• GET /v1/team-invitations/{invitationId}
• DELETE /v1/team-invitations/{invitationId}
• POST /v1/team-invitations/{invitationId}/accept
• POST /v1/team-invitations/{invitationId}/resend
• GET /v1/teams
• POST /v1/teams
• GET /v1/teams/{teamId}
• DELETE /v1/teams/{teamId}
• PATCH /v1/teams/{teamId}
• GET /v1/teams/{teamId}/access/defaults
• PUT /v1/teams/{teamId}/access/defaults
• GET /v1/teams/{teamId}/auto-enroll
• POST /v1/teams/{teamId}/auto-enroll
• DELETE /v1/teams/{teamId}/auto-enroll/{entryId}
• GET /v1/teams/{teamId}/billing
• GET /v1/teams/{teamId}/entitlements
• GET /v1/teams/{teamId}/identity-connections
• POST /v1/teams/{teamId}/identity-connections
• DELETE /v1/teams/{teamId}/identity-connections/{connectionId}
• PATCH /v1/teams/{teamId}/identity-connections/{connectionId}
• POST /v1/teams/{teamId}/join
• POST /v1/teams/{teamId}/leave
• GET /v1/teams/{teamId}/members
• DELETE /v1/teams/{teamId}/members/{memberId}
• PATCH /v1/teams/{teamId}/members/{memberId}
• GET /v1/teams/{teamId}/plan-policy
• POST /v1/teams/{teamId}/restore
• GET /v1/teams/{teamId}/settings
• PATCH /v1/teams/{teamId}/settings
• GET /v1/teams/{teamId}/spaces
• GET /v1/teams/{teamId}/usage
• GET /v1/teams/{teamRef}/grants
• DELETE /v1/teams/{teamRef}/grants/{grantId}