Syntic Platform Docs
BuildAgentsEvaluateConsole & adminGuidesPromptingCookbookModels & pricingSDKs & toolsRelease notesHelpAPI reference
API referenceConsoleSign in
  • Home
  • Build
  • Agents
  • Evaluate
  • Console & admin
  • API reference
  • Resources
  • Guides
  • Prompting
  • Cookbook
  • Models & pricing
  • SDKs & tools
  • Release notes
  • FAQ & glossary
  • Overview
  • Authentication
  • Inference
  • Chat completions
    • Create a chat completion
    • Count tokens
  • Messages
    • Create a message
    • Count tokens
  • Models
    • Overview & model object
    • List models
    • Get a model
  • Embeddings
  • Files & batches
  • Files
    • Overview
    • Upload a file
    • List files
    • Get a file
    • Update a file
    • Download content
    • Delete a file
  • Batches
    • Overview
    • Create a batch
    • List batches
    • Get a batch
    • Stream results
    • Cancel a batch
    • Delete a batch
  • Platform
  • Webhooks
    • Overview & events
    • Register a webhook
    • List webhooks
    • Get a webhook
    • Update a webhook
    • Delete a webhook
    • Rotate signing secret
    • Send a test event
    • List deliveries
    • Redeliver an event
    • Event catalog
      • Overview
        • batch.completed
        • batch.failed
        • batch.expired
        • batch.canceled
        • file.expired
        • session.idle
        • session.requires_action
        • session.error
        • deployment.run.failed
        • deployment.paused
        • environment.build.succeeded
        • environment.build.failed
        • memory.consolidation.completed
        • runner.offline
        • spend.threshold_reached
        • credits.low_balance
        • spend_limit.request_created
        • inference_hook.failing
        • encryption_key.unavailable
        • webhook.test
        • compliance.export.completed
        • eval.run.completed
        • tunnel.disconnected
        • plugin.scan_failed
    • Sign in with Syntic
    • Revoke a sign-in
    • Exchange a workload token
    • Get the signed-in user
    • Introspect a token
      • Register an app
      • List apps
      • Get an app
      • Update an app
      • Rotate secret
      • Delete an app
  • MCP tunnels
    • Overview
    • Create a tunnel
    • List tunnels
    • Get a tunnel
    • Update a tunnel
    • Delete a tunnel
    • Rotate token
    • Connections
      • Issue a certificate
      • List certificates
      • Get a certificate
      • Revoke a certificate
  • Evaluate
  • Evaluations
    • Overview
      • Create a dataset
      • List datasets
      • Get a dataset
      • Update a dataset
      • Delete a dataset
        • Add items
        • Import from a file
        • List items
        • Update an item
        • Delete an item
      • Create a grader
      • List graders
      • Get a grader
      • Update a grader
      • Delete a grader
      • Test a grader
      • Start a run
      • List runs
      • Get a run
      • Cancel a run
      • List results
  • Prompt tools
    • Overview
    • Generate a prompt
    • Improve a prompt
    • Templatize a prompt
      • Create a template
      • List templates
      • Get a template
      • Add a version
      • Move a label
      • Delete a template
  • Conventions
  • Stream format
  • Error codes
  • Error code index
      • invalid_json
      • messages_required
      • invalid_request
      • context_length_exceeded
      • model_unavailable
      • invalid_surface
      • invalid_capability
      • beta_required
      • unknown_beta
      • invalid_version
      • unsupported_parameter
      • invalid_parameter
      • unauthenticated
      • invalid_api_key
      • revoked_api_key
      • expired_api_key
      • invalid_token
      • token_revoked
      • quota_exhausted
      • public_key_rejected
      • origin_not_allowed
      • insufficient_scope
      • account_disabled
      • org_unavailable
      • org_membership_required
      • plan_required
      • model_not_in_plan
      • zero_retention_unavailable
      • feature_unavailable
      • forbidden
      • admin_key_required
      • inference_not_allowed
      • ip_not_allowed
      • region_mismatch
      • policy_denied
      • model_not_found
      • not_found
      • method_not_allowed
      • endpoint_not_supported
      • request_timeout
      • conflict
      • idempotency_key_reused
      • resource_conflict
      • payload_too_large
      • too_many_messages
      • output_schema_violation
      • rate_limited
      • model_busy
      • capacity_busy
      • internal_error
      • server_misconfigured
      • upstream_error
      • upstream_unavailable
      • stream_error
      • authorization_unavailable
      • usage_check_unavailable
      • plan_check_unavailable
      • models_unavailable
      • model_retention_unverifiable
      • service_unavailable
      • upstream_timeout
    • All codes
  • Rate-limit headers
  • Request IDs
  • Versioning & beta flags
  • OpenAPI description
  • Objects
    • All objects
    • activity
    • admin_key
    • agent
    • agent_execution
    • api_key
    • audit_event
    • batch
    • chat_record
    • code_session_record
    • compliance_export
    • compliance_user
    • data_residency
    • deployment
    • deployment_run
    • encryption_key
    • environment
    • eval_dataset
    • eval_grader
    • eval_item
    • eval_run
    • federation_issuer
    • file
    • group
    • inference_hook
    • invite
    • legal_hold
    • mcp_policy
    • memory_consolidation
    • memory_store
    • model
    • oauth_app
    • organization
    • plugin
    • plugin_marketplace
    • plugin_version
    • project_record
    • prompt_template
    • retention_settings
    • runner
    • service_account
    • session
    • session_resource
    • session_thread
    • skill
    • spend_limit_request
    • spend_limits
    • token_count
    • trust_rule
    • tunnel
    • tunnel_certificate
    • user
    • user_profile
    • vault
    • webhook
    • workspace
    • workspace_member
  • Product APIs
  • Agents API
    • Overview
      • Create an agent
      • List agents
      • Get an agent
      • Update an agent
      • List versions
      • Get a version
      • Archive an agent
      • Delete an agent
      • Start a session
      • List sessions
      • Get a session
      • Update a session
      • Send events
      • Stream events
      • List events
      • Interrupt
      • Archive
      • Delete
        • Add a resource
        • List resources
        • Get a resource
        • Update a resource
        • Remove a resource
        • List threads
        • Get a thread
        • List thread events
        • Interrupt a thread
      • List executions
      • Get an execution
      • List traces
      • Terminate
      • Delete
      • Create
      • List
      • Get
      • Update
      • Rebuild
      • Build log
      • Delete
      • Register a runner
      • List runners
      • Get a runner
      • Deregister a runner
        • Claim work
        • Extend a work lease
        • Complete work
        • Release work
      • Create a store
      • List stores
      • Get a store
      • Update a store
      • Delete a store
        • Add a memory
        • List memories
        • Get a memory
        • Search memories
        • Update a memory
        • Delete a memory
        • Delete a scope
        • Export
        • Start a job
        • List jobs
        • Get a job
        • Cancel a job
      • Create a vault
      • List vaults
      • Get a vault
      • Update a vault
      • Delete a vault
        • Set a secret
        • List secrets
        • Get secret metadata
        • Delete a secret
      • Create
      • List
      • Get
      • Update
      • Pause
      • Resume
      • Inbound trigger
      • Delete
        • Run now
        • List runs
        • Get a run
        • Cancel a run
      • Create a skill
      • List skills
      • Get a skill
      • Update a skill
      • Delete a skill
        • Create a version
        • List versions
        • Get a version
        • Download a version
        • Delete a version
      • Create a profile
      • List profiles
      • Get a profile
      • Update a profile
      • Delete a profile
    • Session event types
      • All event types
        • status.changed
        • message.delta
        • message.completed
        • tool_call.started
        • tool_call.progress
        • tool_call.completed
        • approval.required
        • usage.updated
        • error
        • resource.added
        • resource.removed
        • thread.started
        • thread.completed
        • user.message
        • user.tool_result
        • user.approval
        • user.interrupt
  • Admin API
    • Overview
    • Admin keys
      • Admin API & keys
      • List admin keys
      • Get an admin key
      • Update an admin key
    • Organization
      • Overview
      • Get the organization
      • Update the organization
    • Workspaces
      • Overview
      • Create
      • List
      • Get
      • Update
      • Archive
      • Unarchive
      • List members
      • Add a member
      • Get a member
      • Update a member
      • Remove a member
    • Members
      • Overview
      • List members
      • Get a member
      • Update a member
      • Remove a member
    • Invites
      • Overview
      • Create an invite
      • List invites
      • Get an invite
      • Resend
      • Cancel
      • Create
      • List
      • Get
      • Update
      • Delete
        • List members
        • Add a member
        • Remove a member
    • API keys
      • Overview
      • List API keys
      • Get an API key
      • Update an API key
      • Create
      • List
      • Get
      • Update
      • Archive
      • Unarchive
        • Create a rule
        • List rules
        • Update a rule
        • Delete a rule
      • Register an issuer
      • List issuers
      • Get an issuer
      • Update an issuer
      • Remove an issuer
      • Usage report
        • Overview
        • Get the usage report
      • Cost report
        • Overview
        • Get the cost report
        • Summary
        • By model
        • By API key
        • By member
        • Server tools
        • Agents
      • Syntic Code usage
        • Overview
        • Get analytics
      • Rate limits
        • Overview
        • Organization limits
        • Workspace limits
        • Set workspace limits
        • Clear workspace limits
      • Spend limits
        • Overview
        • Get spend limits
        • Set a spend limit
        • Update settings
          • Request a higher limit
          • List requests
          • Get a request
          • Approve or deny
        • List commitments
        • Usage
      • Audit feed
        • Overview
        • List audit events
        • Get an audit event
        • Get settings
        • Update settings
        • Get settings
        • Update settings
        • Get the key
        • Set the key
        • Verify
        • Rotate
        • History
        • Get the hook
        • Configure the hook
        • Test the hook
        • Rotate secret
        • Remove the hook
        • Get the policy
        • Set the policy
        • Add a plugin
        • List plugins
        • Get a plugin
        • Update policy
        • Remove a plugin
          • Add a version
          • List versions
          • Get a version
          • Add a marketplace
          • List marketplaces
          • Get a marketplace
          • Sync now
          • Remove a marketplace
  • Compliance API
    • Overview
      • List activities
      • Get an activity
      • Create an export
      • List exports
      • Get an export
      • Download
      • Cancel
      • List users
      • Get a user
      • List roles
      • List chats
      • Get a chat
      • Delete a chat
      • List files
      • Download a file
      • List projects
      • Get a project
      • Delete a project
      • List documents
      • Download a document
      • List sessions
      • Get a session
      • Delete a session
      • List artifacts
      • Download an artifact
      • Create a hold
      • List holds
      • Get a hold
      • Release a hold
  • Not public
  • Conversations (mobile only)

On this page

  • Example
  • Handling
API referenceAgents APISession event typesFrom youuser.interrupt

user.interrupt

⚠️
Preview — this feature is being built; the design below is the spec.

Sent by you with Send events. Stop the current turn.

Example

{
  "events": [
    {
      "type": "user.interrupt"
    }
  ]
}

Handling

Same as POST /interrupt. The session stays open and becomes idle.

user.approvalAdmin API
Was this page helpful?
Syntic

Company

  • About Syntic
  • Syntic Life
  • The Syntic Charter
  • The Syntic Constitution
  • Join Syntic
  • Frontier Research
  • Newsroom
  • Transparency

The Workforce

  • Syntic Desktop
  • AI Agents
  • Workforce
  • AI Staff
  • AI Call Center
  • Pricing
  • Apps & Downloads

Solutions

  • Engineering Teams
  • Code Security
  • Schools & Universities
  • Banking & Finance
  • Government & Public Sector
  • Healthcare
  • Biotech & Pharma
  • Mission-Driven Orgs

Build

  • API Platform
  • Developer Console
  • API Reference
  • API Pricing
  • Skills Marketplace
  • Skills
  • Connectors
  • Syntic Code
  • Syntic Terminal
  • GitHub

Resources

  • News
  • Tutorials
  • Builder Community
  • Partner Network
  • Startups

Trust & Legal

  • Trust Center
  • Regional Compliance
  • Regional Availability
  • System Status
  • Help Center
  • Deployment Safety Policy
  • Security Disclosure

Terms and policies

  • Privacy Policy
  • Consumer Health Data Privacy Policy
  • Privacy Preferences
  • Business Terms
  • Consumer Terms
  • API Terms
  • Cookie Policy

© 2026 Syntic AI, Inc.