openapi: 3.1.0 info: title: SparkVault API version: 1.2.952 description: Generated from the SparkVault API route definitions. Every method, path, tag, and security requirement reflects the deployed code; request/response schemas appear where routes declare them. servers: - url: https://api.sparkvault.com/v1 tags: - name: account - name: analytics - name: api-keys - name: apps - name: audit-logs - name: auth - name: billing - name: config - name: domains - name: entropy - name: files - name: health - name: identity - name: me - name: messaging - name: notify - name: profile - name: push-tokens - name: settings - name: sparklinks - name: sparks - name: structured-ingots - name: unsubscribe - name: users - name: vaults paths: /account: get: tags: - account security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response put: tags: - account security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /account/logo: delete: tags: - account security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /analytics/activity: get: tags: - analytics security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /analytics/api-keys/{id}: get: tags: - analytics security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /analytics/overview: get: tags: - analytics security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /analytics/spark-activity: get: tags: - analytics security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /analytics/usage-over-time: get: tags: - analytics security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /analytics/vaults/{id}: get: tags: - analytics security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /api-keys: get: tags: - api-keys security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response post: tags: - api-keys security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /api-keys/{id}: delete: tags: - api-keys security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /apps: get: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /apps/hubspot/delete-file: post: tags: - apps security: [] responses: default: description: Response /apps/hubspot/download: post: tags: - apps security: [] responses: default: description: Response /apps/hubspot/files: post: tags: - apps security: [] responses: default: description: Response /apps/hubspot/oauth/callback: post: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /apps/hubspot/resolve: post: tags: - apps security: [] responses: default: description: Response /apps/hubspot/uninstall: delete: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /apps/hubspot/unseal: post: tags: - apps security: [] responses: default: description: Response /apps/salesforce/delete-file: post: tags: - apps security: [] responses: default: description: Response /apps/salesforce/download: post: tags: - apps security: [] responses: default: description: Response /apps/salesforce/files: post: tags: - apps security: [] responses: default: description: Response /apps/salesforce/oauth/callback: post: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /apps/salesforce/resolve: post: tags: - apps security: [] responses: default: description: Response /apps/salesforce/uninstall: delete: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /apps/salesforce/unseal: post: tags: - apps security: [] responses: default: description: Response /apps/salesforce/upload-context: post: tags: - apps security: [] responses: default: description: Response /apps/slack/analytics: get: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /apps/slack/oauth/callback: post: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /apps/slack/uninstall: delete: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /apps/{app_id}: get: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: app_id in: path required: true schema: type: string responses: default: description: Response post: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: app_id in: path required: true schema: type: string responses: default: description: Response put: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: app_id in: path required: true schema: type: string responses: default: description: Response delete: tags: - apps security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: app_id in: path required: true schema: type: string responses: default: description: Response /audit-logs: get: tags: - audit-logs security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /audit-logs/apps: post: tags: - audit-logs security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /audit-logs/apps/{app_slug}: get: tags: - audit-logs security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: app_slug in: path required: true schema: type: string responses: default: description: Response /auth/complete-signup: post: tags: - auth security: - ApiKeyAuth: [] - BearerAuth: [] requestBody: required: true content: application/json: schema: type: object required: - organization_name properties: organization_name: type: string minLength: 1 maxLength: 255 full_name: type: string maxLength: 255 additionalProperties: false responses: default: description: Response /auth/identity/token: post: tags: - auth security: [] requestBody: required: true content: application/json: schema: type: object required: - code - code_verifier properties: code: type: string minLength: 1 maxLength: 512 code_verifier: type: string minLength: 43 maxLength: 128 additionalProperties: false responses: default: description: Response /auth/identity/verify: post: tags: - auth security: [] requestBody: required: true content: application/json: schema: type: object required: - token properties: token: type: string minLength: 1 maxLength: 4096 additionalProperties: false responses: default: description: Response /auth/logout: post: tags: - auth security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /auth/refresh: post: tags: - auth security: [] requestBody: required: false content: application/json: schema: type: object properties: refresh_token: type: string minLength: 1 maxLength: 1024 additionalProperties: false responses: default: description: Response /auth/viewer-token: post: tags: - auth security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/aggregate: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/charge: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/checkout: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/iap/validate: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/invoices: get: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/payment-methods: get: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/payment-methods/setup: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/payment-methods/{id}: delete: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /billing/payment-methods/{id}/default: put: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /billing/portal: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/seats/bulk: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/seats/bulk/preview: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/subscription: get: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/subscription/adjust: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/subscription/adjust/preview: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/subscription/cancel: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/subscription/resume: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/summaries: get: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/transactions: get: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/trial/start: post: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /billing/usage/breakdown: get: tags: - billing security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /config: get: tags: - config security: [] responses: default: description: Response /domains: get: tags: - domains security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response post: tags: - domains security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /domains/{domain}: delete: tags: - domains security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: domain in: path required: true schema: type: string responses: default: description: Response /domains/{domain}/verify: post: tags: - domains security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: domain in: path required: true schema: type: string responses: default: description: Response /entropy/generate: post: tags: - entropy security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /files/in/{vaultId}: get: tags: - files security: [] parameters: - name: vaultId in: path required: true schema: type: string responses: default: description: Response /files/in/{vaultId}/upload: post: tags: - files security: [] parameters: - name: vaultId in: path required: true schema: type: string responses: default: description: Response /health: get: tags: - health security: [] responses: default: description: Response /health/detailed: get: tags: - health security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /me/notifications: get: tags: - me security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /me/notifications/devices: post: tags: - me security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /me/notifications/devices/{token_hash}: delete: tags: - me security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: token_hash in: path required: true schema: type: string responses: default: description: Response /me/notifications/unread-count: get: tags: - me security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /me/notifications/web-push: post: tags: - me security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /me/notifications/web-push/key: get: tags: - me security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /me/notifications/web-push/unsubscribe: post: tags: - me security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /me/notifications/{notificationId}/state: post: tags: - me security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: notificationId in: path required: true schema: type: string responses: default: description: Response /products/identity: get: tags: - identity security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response put: tags: - identity security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/identity/.well-known/web-identity: get: tags: - identity security: [] responses: default: description: Response /products/identity/clients: get: tags: - identity security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response post: tags: - identity security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/identity/clients/{client_id}: delete: tags: - identity security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: client_id in: path required: true schema: type: string responses: default: description: Response /products/identity/fedcm/accounts: get: tags: - identity security: [] responses: default: description: Response /products/identity/fedcm/login: get: tags: - identity security: [] responses: default: description: Response /products/identity/portal/account: delete: tags: - identity security: [] responses: default: description: Response /products/identity/portal/activity: get: tags: - identity security: [] responses: default: description: Response /products/identity/portal/authenticator: get: tags: - identity security: [] responses: default: description: Response /products/identity/portal/authenticator/confirm: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/authenticator/provision: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/authenticator/recovery-codes: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/authenticator/{id}: delete: tags: - identity security: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /products/identity/portal/email: post: tags: - identity security: [] responses: default: description: Response delete: tags: - identity security: [] responses: default: description: Response /products/identity/portal/email/verify: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/lockdown: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/logout: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/me: get: tags: - identity security: [] responses: default: description: Response /products/identity/portal/passkey/register: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/passkey/register/complete: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/passkey/register/handoff: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/passkey/{credentialId}: delete: tags: - identity security: [] parameters: - name: credentialId in: path required: true schema: type: string responses: default: description: Response /products/identity/portal/phone: post: tags: - identity security: [] responses: default: description: Response delete: tags: - identity security: [] responses: default: description: Response /products/identity/portal/phone/verify: post: tags: - identity security: [] responses: default: description: Response /products/identity/portal/profile: patch: tags: - identity security: [] responses: default: description: Response /products/identity/portal/sessions: get: tags: - identity security: [] responses: default: description: Response /products/identity/portal/sessions/{id}: delete: tags: - identity security: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /products/identity/portal/sites: get: tags: - identity security: [] responses: default: description: Response /products/identity/portal/sites/{accountId}: patch: tags: - identity security: [] parameters: - name: accountId in: path required: true schema: type: string responses: default: description: Response /products/identity/portal/sites/{accountId}/notifications: get: tags: - identity security: [] parameters: - name: accountId in: path required: true schema: type: string responses: default: description: Response put: tags: - identity security: [] parameters: - name: accountId in: path required: true schema: type: string responses: default: description: Response /products/identity/portal/social: get: tags: - identity security: [] responses: default: description: Response /products/identity/portal/social/{provider}: post: tags: - identity security: [] parameters: - name: provider in: path required: true schema: type: string responses: default: description: Response delete: tags: - identity security: [] parameters: - name: provider in: path required: true schema: type: string responses: default: description: Response /products/identity/portal/step-up/otp: post: tags: - identity security: [] responses: default: description: Response /products/identity/social/{provider}/callback: get: tags: - identity security: [] parameters: - name: provider in: path required: true schema: type: string responses: default: description: Response post: tags: - identity security: [] parameters: - name: provider in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/.well-known/jwks.json: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/.well-known/openid-configuration: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/authorize: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/backup-verification/send: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/backup-verification/verify: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/config: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/fedcm/assertion: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/fedcm/client_metadata: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/fedcm/config.json: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/introspect: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/otp/send: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/otp/verify: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/passkey/check: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/passkey/list: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/passkey/popup: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/passkey/register: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/passkey/register/complete: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/passkey/register/from-spark: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/passkey/verify: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/passkey/verify/complete: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/passkey/{credential_id}: delete: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string - name: credential_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/recommendations/dismiss: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/revoke: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/saml/{provider}: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string - name: provider in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/saml/{provider}/acs: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string - name: provider in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/second-factor: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/second-factor/verify: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/signin: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/signin/handoff: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/signin/redeem: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/signin/verify-origin: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/social/{provider}: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string - name: provider in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/sparklink/result: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/sparklink/send: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/sparklink/verify: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/sso: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/sso/accounts: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/sso/continue: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/token: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/verify: get: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/verify/session: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/identity/{account_id}/verify/session/resolve: post: tags: - identity security: [] parameters: - name: account_id in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations: post: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/messaging/conversations/{conversationId}: get: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/archive: put: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/attachments: post: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/attachments/{ingotId}/download: get: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string - name: ingotId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/close: put: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/invites: post: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/legal-hold: put: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/messages: get: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response post: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/messages/{messageId}/recall: post: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string - name: messageId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/messages/{messageId}/receipt: get: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string - name: messageId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/opt-out: put: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/participants: post: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/participants/{svid}: delete: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string - name: svid in: path required: true schema: type: string responses: default: description: Response /products/messaging/conversations/{conversationId}/read: post: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: conversationId in: path required: true schema: type: string responses: default: description: Response /products/messaging/healthz: get: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/messaging/inbox: get: tags: - messaging security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/notify/config: get: tags: - notify security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response put: tags: - notify security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/notify/healthz: get: tags: - notify security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/notify/inbox: get: tags: - notify security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/notify/inbox/{notificationId}/state: post: tags: - notify security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: notificationId in: path required: true schema: type: string responses: default: description: Response /products/notify/receipts: get: tags: - notify security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/notify/send: post: tags: - notify security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /products/notify/sends/{sendId}/receipts: get: tags: - notify security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: sendId in: path required: true schema: type: string responses: default: description: Response /products/notify/sends/{sendId}/status: get: tags: - notify security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: sendId in: path required: true schema: type: string responses: default: description: Response /products/structured-ingots/{vault_id}: get: tags: - structured-ingots security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: vault_id in: path required: true schema: type: string responses: default: description: Response post: tags: - structured-ingots security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: vault_id in: path required: true schema: type: string responses: default: description: Response /products/structured-ingots/{vault_id}/{ingot_id}: get: tags: - structured-ingots security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: vault_id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response patch: tags: - structured-ingots security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: vault_id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response delete: tags: - structured-ingots security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: vault_id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response /profile: get: tags: - profile security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response put: tags: - profile security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /push-tokens: post: tags: - push-tokens security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /push-tokens/{token_hash}: delete: tags: - push-tokens security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: token_hash in: path required: true schema: type: string responses: default: description: Response /settings/email/request-change: post: tags: - settings security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /settings/email/verify-change: post: tags: - settings security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /sparklinks: get: tags: - sparklinks security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /sparklinks/{code}: get: tags: - sparklinks security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: code in: path required: true schema: type: string responses: default: description: Response delete: tags: - sparklinks security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: code in: path required: true schema: type: string responses: default: description: Response /sparks: get: tags: - sparks security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response post: tags: - sparks security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /sparks/shared/{id}/meta: get: tags: - sparks security: - ApiKeyAuth: [] - BearerAuth: [] - {} parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /sparks/{id}: get: tags: - sparks security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response delete: tags: - sparks security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /sparks/{id}/share: get: tags: - sparks security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response patch: tags: - sparks security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response delete: tags: - sparks security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /unsubscribe: get: tags: - unsubscribe security: [] responses: default: description: Response /users: get: tags: - users security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /users/accept-invite: get: tags: - users security: [] responses: default: description: Response post: tags: - users security: [] responses: default: description: Response /users/invite: post: tags: - users security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /users/{id}: patch: tags: - users security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response delete: tags: - users security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /users/{id}/resend-invite: post: tags: - users security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults: get: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] responses: default: description: Response /vaults/{id}: get: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response put: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response delete: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/access-log-retention: get: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response put: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/audit-logs: get: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/contents: get: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/dvaks: get: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/dvaks/{last4}: delete: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string - name: last4 in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/folders: get: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response post: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/folders/{fid}: get: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: fid in: path required: true schema: type: string responses: default: description: Response put: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: fid in: path required: true schema: type: string responses: default: description: Response delete: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: fid in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/ingots: get: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response post: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/ingots/search: get: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/ingots/{ingot_id}: get: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response put: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response patch: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response delete: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/ingots/{ingot_id}/audit-logs: get: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/ingots/{ingot_id}/download: post: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/ingots/{ingot_id}/sharing: get: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response put: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/ingots/{ingot_id}/sharing/invite: post: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/ingots/{ingot_id}/sharing/invite/{invite_id}: delete: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string - name: invite_id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/ingots/{ingot_id}/sharing/invite/{invite_id}/resend: post: tags: - vaults security: - ApiKeyAuth: [] VaultAccessToken: [] - BearerAuth: [] VaultAccessToken: [] parameters: - name: id in: path required: true schema: type: string - name: ingot_id in: path required: true schema: type: string - name: invite_id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/seal: post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/sharing: get: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response put: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/sharing/disable: post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/sharing/enable: post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/unseal: post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/upload: get: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response put: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/upload/portal/disable: post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/upload/portal/enable: post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/upload/widget/disable: post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response /vaults/{id}/upload/widget/enable: post: tags: - vaults security: - ApiKeyAuth: [] - BearerAuth: [] parameters: - name: id in: path required: true schema: type: string responses: default: description: Response components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-Key description: SparkVault API key (create one at https://app.sparkvault.com/api/keys). BearerAuth: type: http scheme: bearer bearerFormat: JWT description: SparkVault session JWT issued by the auth endpoints. VaultAccessToken: type: apiKey in: header name: X-Vault-Access-Token description: Vault Access Token minted by POST /vaults/{id}/unseal; required for ingot operations.