For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

User Guide Developer Guides API Reference

Skip to navigation

Runtype API Devices

List paired devices

GET

/v1/devices

GET

/v1/devices

curl https://api.runtype.com/v1/devices \
     -H "Authorization: <apiKey>"

{
  "data": [
    {
      "appVersion": "string",
      "createdAt": "string",
      "id": "string",
      "lastAuthenticatedAt": "string",
      "mcpUrl": "string",
      "name": "string",
      "platform": "macos",
      "publicKeyFingerprint": "string",
      "revokedAt": "string",
      "status": {
        "availableTools": [
          "string"
        ],
        "deviceId": "string",
        "online": true,
        "appVersion": "string",
        "lastSeenAt": "string",
        "protocolVersion": 1.1
      },
      "updatedAt": "string"
    }
  ]
}

Authentication

AuthorizationBearer

API key or Clerk session token

Response

Owned devices and relay status

datalist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

Was this page helpful?

Register this computer as a local loopback device (development only)

User Guide Developer Guides API Reference

- Overview
Runtype API

Overview
Identity assertion signing keys (JWKS)
Agent issuer metadata
List identity integrations
Create an identity integration
Get an identity integration
Delete an identity integration
Update an identity integration
Get an agent access token
List release aliases with one name across the organization
List release aliases for an agent
Get one release alias
Activate a version at a release alias
Archive a release alias
Read the secret binding names of a release alias
Replace the secret bindings of a release alias
Clear the secret bindings of a release alias
Roll a release alias back to its previous version
List deployment receipts for an agent
Report a problem
List versions for an agent
Publish a specific agent version
Get the published version for an agent
Get a specific agent version
List agents
Create agent
Ensure agent (config-as-code converge)
Fetch external agent card
Pull agent definition (config-as-code)
Get agent details
Update agent
Delete agent
Resolve a pending agent tool approval
Add capability to agent
Remove capability from agent
List internal agent conversation events
List agent credentials
Register an agent public key
Create an agent client secret
Revoke an agent credential
Execute agent
List agent executions
Get execution detail
Cancel a detached agent execution
Stream execution events
List tool calls
Get tool call detail
Export agent for runtime
Publish agent
Refresh cached agent card
Resume a paused agent execution
Roll up recent runs of an agent
List managed agent runs
Get a managed agent run
Get the agent token audience policy
Replace the agent token audience policy
Execute agent voice (text-to-speech)
Create a voice test draft
Get product usage by end user
Get record results
Get analytics stats
Store an asset
Preview asset
Extend preview expiry
Get asset
Get internal asset
Get current user info
Provision the caller workspace organization
Cancel a batch execution
Submit a batch flow execution
Get batch execution status
Get batch summary
Get per-record cost for a batch
Get step results for a batch record
Get batch execution total cost
WebSocket for real-time batch updates
List client tokens
Create client token
Get client token
Update client token
Delete client token
List conversations for client token
Regenerate client token
Get client token value
Prewarm browser voice for an agent
Answer an end-user approval gate
Answer an end-user approval gate
Send a client chat message
List the visitor's own conversations
Delete all of the visitor's own conversations
Stop a durable client execution
Read a live input delivery receipt
Read one of the visitor's own conversations
Delete one of the visitor's own conversations
Finalize the visible text of stored messages
Submit feedback on a message
Initialize a client session
Resume a paused client execution
Resume a paused client execution
Reset the current browser visitor
List collections
Create a collection
Ensure collection (config-as-code converge)
Generate TypeScript types for schematized collections
Get a collection
Delete a collection
Update a collection
Infer a schema from existing records
Pull collection definition (config-as-code)
Dry-run existing records against a schema
List context templates
Create context template
Get context template
Update context template
Delete context template
List conversations
Create a conversation
Get conversation with messages
Update a conversation
Delete a conversation
List data connections
Create connect session
Sync connections
Get data connection
Delete data connection
Update connection status
List connection tools
List decision models
Ask for a judgment (hosted DecisionProvider)
List delegate tasks
Delegate a task to the Runtype operator agent
Get a delegate task
Cancel a delegate task
Stream a delegate task
Send a message to a delegate task
List paired devices
Register this computer as a local loopback device (development only)
Claim a one-time pairing code from a Mac
Create a one-time device pairing session
Get a paired device
Exchange a signed device challenge for a short-lived relay token
Revoke a paired device
Execute a flow or agent
Approve or deny a pending approval
Approve or deny a pending approval
Continue a paused execution
Continue a paused execution
Resume a paused execution
Resume a paused execution
Search documentation
Get platform documentation
Get build instructions
Exchange a sign-in token for end-user credentials
JWKS for Runtype-issued end-user JWTs
Rotate an end-user refresh token
Request an end-user sign-in email
Begin end-user OAuth connection
Analyze step results
List eval batches
Compare evals
Compare record across evals
Ensure default eval suites
Ensure eval suite (config-as-code converge)
Preview trace-to-eval capture for a run
Decompose grader criteria
Get eval group
Pull eval suite definition (config-as-code)
Run eval suite synchronously
Get persisted grader scores for an eval run
Review an AI-grader verdict
Stream eval execution
Submit eval
List eval suites
Create eval suite
Get eval suite
Delete eval suite
Update eval suite
Add eval cases
Capture an eval case from a run
Delete eval case
Update eval case
Get eval suite coverage
Generate eval case proposals
List eval case proposals
Accept an eval case proposal
Reject an eval case proposal
Run eval suite
Get eval results
Poll product events
List event types
Inspect a durable input delivery
Stream execution events
Read an execution journal
Poll an asynchronous execution
List extraction models
Extract typed fields (hosted ExtractionProvider)
List feedback with filters
Submit feedback on a message
Get feedback statistics
Get specific feedback record
Delete feedback record
Get all flow steps for a flow
List versions for a flow
Publish a specific flow version
Get the published version for a flow
Get a specific flow version
List flows
Create flow
Ensure flow (config-as-code converge)
Pull flow definition (config-as-code)
Get flow details
Update flow
Delete flow
Export flow for runtime (limited preview)
Publish flow
Run flow on records of a type
List flow step results
List integration configs
Get integration config status
Create or update an integration config
Delete an integration config
List integrations
Reserve a new integration
List integrations by category
List connected integration accounts
Get integration credential status
Install Granola integration
Check Slack app creation status
Install Slack integration
Generate Slack app manifest
Rotate Slack credentials
Install Telegram integration
Check managed Telegram bot availability
Initiate managed Telegram bot creation
Rotate managed Telegram bot token
Cancel managed Telegram bot request
Confirm managed Telegram bot rename
Reject managed Telegram bot rename
Get managed Telegram bot request status
List configured integration tools
List Vectorize configurations
Create Vectorize configuration
Create Vectorize index
List Vectorize indexes
Test new Vectorize configuration
Get Vectorize configuration
Update Vectorize configuration
Delete Vectorize configuration
Test saved Vectorize configuration
List Weaviate configurations
Create Weaviate configuration
Test new Weaviate configuration
Get Weaviate configuration
Update Weaviate configuration
Delete Weaviate configuration
List Weaviate collections
Test Weaviate connection
Get integration details
Save integration credentials
Delete integration credentials
List tools for an integration
Get an integration tool
Query customer logs
Context snapshots for an execution
Captured text of context blocks
Read one log entry in full
Get aggregated log stats
Trace a conversation
Trace an execution
List child executions of a run
Explain a run using retained trace evidence
List conversations
Create conversation
Get conversation
Update conversation
Delete conversation
List messages
Create message
Resume agent handling
Send human-authored message
Take over conversation
Trigger an immediate IMAP poll
Start IMAP polling
Get IMAP polling status
Stop IMAP polling
Send a test email via SMTP
Verify IMAP + SMTP connection
Validate Slack bot token (deprecated)
Validate Telegram bot token (deprecated)
Validate channel credentials
Send echo message
List model configurations
Create model configuration
List available models
Get grouped models
List search-capable models
List configured search providers
Get model configuration usage
Update model configuration
Delete model configuration
Set default model configuration
Enable or disable model configuration
Get model usage statistics
Get model usage details
List products
Create product
Assemble product from FPO
Ensure product (config-as-code converge)
Ensure full product (config-as-code converge of the whole FPO)
Pull product definition (config-as-code)
Pull full product (reconstruct the whole FPO from the live graph)
Get product details
Update product
Delete product
Get product activity
Add capability to product
Update capability
Remove capability
Preview cleanup resources
List product comments
Start a product comment thread
Resolve a product comment thread
Reply in a product comment thread
Get product configuration summary
Get product setup readiness
Declare product stack
List surfaces
Create surface
Ensure surface (config-as-code converge)
Pull surface definition (config-as-code)
Get surface details
Update surface
Delete surface
Set the answering capability of a chat surface
Add item to surface
Update surface item
Remove surface item
Create surface API key
Delete surface API key
Reveal test surface key
List schedules for surface
Create schedule for surface
Get schedule details
Update schedule
Delete schedule
Pause schedule
Resume schedule
Run schedule immediately
Get surface setup readiness
Configure webhook from documentation
Infer schema from JSON payload
Toggle webhook learning mode
Get webhook field mappings
Update webhook field mappings
List webhook observations
Clear webhook observations
Get event routing configuration
Update event routing configuration
Get webhook schema
Upload webhook schema
Confirm proposed schema
A2A JSON-RPC endpoint
Get A2A Agent Card
Get A2A surface info
List discovered WebMCP tools
List observed page origins
List surfaces
Get surface details
Read a channel context window
Send a provider fixture through a surface’s real ingress
MCP manifest
OAuth protected resource metadata
MCP surface info
Execute an MCP surface tool (dashboard test)
List MCP surface tools (dashboard test)
List prompts
Create a prompt
Get prompt details
Update a prompt
Delete a prompt
List provider keys
Create a provider key
Discover models from endpoint
Select organization model-provider credential custody
List provider keys by provider
Delete a provider key
Update a provider key
Discover models from existing key
Sync models for a provider key
Get provider status
Get available embedding models
Validate a prospective flow payload
Validate a full product object (FPO)
Validate a product template
Validate a standalone agent definition
Validate a standalone flow definition
Validate a standalone surface definition
Validate a standalone tool definition
List question sets
Create a question set
Ensure question set (config-as-code converge)
Pull question set definition (config-as-code)
Get a question set
Update a question set
Resolve a question set
List a question set's versions
List a question set version's calibrations
Record a calibration for a question set version
Publish a question set version
List records
Create record
Bulk delete records
Bulk edit records
Export records as CSV
Get field values
Preview record filter
Discover record schema
Upload CSV records
Get record details
Update record
Delete record
Get record costs
Get record results
Delete record result
Get record step results
Get available resources
List runs
Count runs
Read one run
Execute a synchronous site crawl
Send a rendered email from a standalone runtime
Recall memories (hosted MemoryStore.recall)
Save a memory (hosted MemoryStore.remember)
Summarize a memory profile (hosted MemoryStore.getSummary)
Get a record by id or type+name (hosted RecordStore.get)
Query records (hosted RecordStore.query)
Update a record by id (hosted RecordStore.update)
Upsert a record (hosted RecordStore.upsert)
Execute a hosted web search for a standalone runtime
List managed sandbox deployments
Create a managed sandbox deployment
List retained managed deployment runtime profiles
Upload a managed deployment source bundle
Get a managed sandbox deployment
Replace a managed sandbox deployment spec
Destroy a managed sandbox deployment
Read the accepted deployment definition
List deployment ingress credentials
Issue a deployment ingress credential
Revoke a deployment ingress credential
Rotate a deployment ingress credential
Get one deployment operation
Renew a managed sandbox deployment
Resume a managed sandbox deployment
Suspend a managed sandbox deployment
List schedules
Create a schedule
Get results for a batch execution
Ensure schedule (config-as-code converge)
Pull schedule definition (config-as-code)
List all schedule runs
Get results for a scheduled run
Get schedule sparklines
Get a schedule
Update a schedule
Delete a schedule
Pause a schedule
Resume a schedule
Run a schedule immediately
List runs for a schedule
Get schedule statistics
List secrets (metadata only)
Create a secret
Check which secret keys exist, are missing, or revoked
Get intake manifest for secret configuration
Submit secret values from intake screen
Generate dashboard URL for configuring missing secrets
Get secret metadata
Update or rotate a secret
Delete a secret
List signal bindings
Bind a signal set to an agent
Unbind a signal set
List signal sets
Create a signal set
List signal set presets
Get a signal set
Update a signal set
Publish a signal set version
Preview a signal set version
Signal stats
List pending skill proposals
Approve a skill proposal
Reject a skill proposal
List skills
Create a skill
Bind a skill to an agent
List an agent's skill bindings
Unbind a skill from an agent
Ensure skill (config-as-code converge)
Import a SKILL.md
Propose a skill (deployed-agent data plane)
Pull skill definition (config-as-code)
Get a skill
Append a new skill version
Delete a skill
List the agents a skill is bound to
List a skill's versions
Publish a skill version
Inspect OTLP admission, queryability, and durable recovery debt
List remembered tool-approval grants
Revoke a remembered tool-approval grant
List tools
Create tool
List built-in tools
List compatible built-in tools
Get built-in tool schema
Ensure tool (config-as-code converge)
Convert flow to tool
Pull tool definition (config-as-code)
Deploy Runtype Sandbox
Cleanup Runtype Sandbox
Deploy Daytona sandbox
Cleanup Daytona sandbox
Get tool schemas
Get tool details
Update tool
Delete tool
Execute tool
Test tool
Get usage statistics
Get daily execution usage
Complete onboarding
Set onboarding intent
Reset onboarding
Get user profile
Update user profile
Get user statistics
Validate Liquid template
Validate transform code