Agency

Framework

  • Start Guide
    • Getting started with Agency Server
    • Prerequisites
    • Installation
    • Core concepts
    • Services overview
    • UI development
    • Next steps
  • Concepts
    • Repos
    • Domain lifecycle
    • Realtime
    • Knowledge
    • UI
    • Principles (short)
  • Architecture
    • Product / runtime
    • Reference host / deployment
    • Engineering umbrella
    • How they connect
  • Veronica — built-in secretary
    • Role
    • Inference
    • Shipped content
    • Secretary tools
    • UI projection
      • Chat surfaces (operator UX)
      • Live presence
    • Example missions
  • Agency Display
    • Core boundaries
      • Display runtime and reactive state
      • Geospatial and media fleets
      • Display and fleet security
  • Tutorials
    • Create your first Agent
      • Prerequisites
      • What you need
      • Create or reuse a Model
      • Create an Agent
      • Smoke test (no Execution lifecycle)
      • What persists / what does not
      • Possible improvements (not implemented)
    • Create and execute a Mission
      • Vocabulary
      • Create a Mission
      • Associate an Agent
      • Dispatch (current mechanism)
      • Locate Execution, Thread, Runs
      • Obtain the result
      • ASCII lifecycle
    • Example missions (boot seed)
      • Namespaces
      • Catalog
      • Try in Mission Control
      • Adding examples
    • Example display views (boot seed)
      • Catalog
      • Media image + Media picker (nabla-link)
      • Agent tools
      • Adding examples
    • Human-in-the-Loop
      • Target shape
      • How a tool interrupts
      • Persistence
      • Why Run #1 stays INTERRUPTED
      • Delivering the human answer
      • After answer
      • DB / Celery / WebSocket roles
      • Current behaviour note (resume_mission)
      • ASCII
  • RAG
    • Shape
    • API surface (today)
    • Module reference
      • slugify_for_collection()
      • Tenant
      • TenantMembership
      • Workspace
      • Document
      • Extraction
      • Extract
      • Section
      • Chunk
  • Deployment
    • Containers
    • Workflow
    • Protocols
    • Boot
    • Authentication
  • Development
    • Workspace
      • Stack (delegates to agency-server/dev)
      • Tests (umbrella)
      • WSL Docker
    • Server
      • Container name resolution
      • Commands
      • Documentation
      • Product URLs (default)
      • Voice (STT/TTS)
      • ComfyUI (image gen)
    • UI
      • Sites
      • UI Schema
      • Agency Bus
      • Frontend components (agency-ui)
      • Python: serving the SPA
      • Mission Control
      • Three-repo split
      • Core principle
      • User preferences & Desktop
      • Desktop vs Mission Control
      • Development & publish
    • Processes
      • Execution Runtime
      • Agent Runtime
      • Mission loop (technical reference)
      • Realtime
      • Celery and Agency lifecycle
    • Scope model
    • REST (Phase 1 shipped)
      • Dispatch and special actions
      • WebSocket (Phase 2 shipped)
      • Corpus (Phase 3 shipped)
      • Verification
    • Connections
      • Philosophy
      • Socket inventory
      • Groups (publish side)
      • Primary socket: /channel/
      • Catalog observe (bus envelope)
      • Desktop chrome (bus envelope)
      • Task monitor (/channel/task/)
      • Agent test socket (/channel/agent/<uuid>/)
      • Ephemeral rooms (/channel/room/<slug>/)
      • HITL flow
      • Related code
    • Tests and CI
      • Backend (pytest)
      • Frontend (Vitest)
      • Continuous integration
  • Change log
    • 2026-08-28
    • 2026-08-27
    • 2026-08-26
    • 2026-08-25
    • 2026-08-24
    • 2026-08-23
    • 2026-08-22

Reference

  • Models
    • Intents
    • Execution flow
    • User
    • Task
      • Task.State
      • Task.id
      • Task.name
      • Task.state
      • Task.args
      • Task.kwargs
      • Task.result
      • Task.clock
      • Task.created_at
      • Task.DoesNotExist
      • Task.MultipleObjectsReturned
      • Task.get_next_by_created_at()
      • Task.get_previous_by_created_at()
      • Task.get_state_display()
      • Task.objects
    • Provider
      • Provider.Kind
      • Provider.id
      • Provider.name
      • Provider.url
      • Provider.kind
      • Provider.api_key_env
      • Provider.models
      • Provider.save()
      • Provider.update_models()
      • Provider.sync_models()
      • Provider.DoesNotExist
      • Provider.MultipleObjectsReturned
      • Provider.get_kind_display()
      • Provider.objects
    • Model
      • Model.id
      • Model.name
      • Model.provider
      • Model.notes
      • Model.tools
      • Model.vision
      • Model.metadata
      • Model.modified_at
      • Model.size
      • Model.parameter_size
      • Model.digest
      • Model.format
      • Model.family
      • Model.removed
      • Model.agents
      • Model.DoesNotExist
      • Model.MultipleObjectsReturned
      • Model.get_next_by_modified_at()
      • Model.get_previous_by_modified_at()
      • Model.objects
      • Model.provider_id
    • Tool
      • Tool.id
      • Tool.namespace
      • Tool.definition
      • Tool.help
      • Tool.icon
      • Tool.agents
      • Tool.DoesNotExist
      • Tool.MultipleObjectsReturned
      • Tool.objects
    • Skill
      • Skill.id
      • Skill.name
      • Skill.description
      • Skill.text
      • Skill.DoesNotExist
      • Skill.MultipleObjectsReturned
      • Skill.objects
    • Voice
      • Voice.Provider
      • Voice.id
      • Voice.name
      • Voice.provider
      • Voice.key
      • Voice.language
      • Voice.locale
      • Voice.gender
      • Voice.quality
      • Voice.DoesNotExist
      • Voice.MultipleObjectsReturned
      • Voice.agents
      • Voice.get_provider_display()
      • Voice.objects
    • Agent
      • Agent.id
      • Agent.name
      • Agent.namespace
      • Agent.system_key
      • Agent.shipped_content_hash
      • Agent.is_customized
      • Agent.model
      • Agent.voice
      • Agent.tools
      • Agent.deep
      • Agent.instructions
      • Agent.icon
      • Agent.created_at
      • Agent.updated_at
      • Agent.executions
      • Agent.threads
      • Agent.interruptions
      • Agent.by_name()
      • Agent.get_tools()
      • Agent.test()
      • Agent.execute()
      • Agent.DoesNotExist
      • Agent.MultipleObjectsReturned
      • Agent.get_next_by_created_at()
      • Agent.get_next_by_updated_at()
      • Agent.get_previous_by_created_at()
      • Agent.get_previous_by_updated_at()
      • Agent.messages
      • Agent.model_id
      • Agent.objects
      • Agent.voice_id
    • Mission
      • Mission.id
      • Mission.name
      • Mission.namespace
      • Mission.system_key
      • Mission.shipped_content_hash
      • Mission.is_customized
      • Mission.prompt
      • Mission.loop_prompt
      • Mission.max_iterations
      • Mission.loop_delay_seconds
      • Mission.created_at
      • Mission.updated_at
      • Mission.executions
      • Mission.is_loop
      • Mission.clean()
      • Mission.save()
      • Mission.by_name()
      • Mission.dispatch()
      • Mission.DoesNotExist
      • Mission.MultipleObjectsReturned
      • Mission.get_next_by_created_at()
      • Mission.get_next_by_updated_at()
      • Mission.get_previous_by_created_at()
      • Mission.get_previous_by_updated_at()
      • Mission.objects
    • Execution
      • Execution.Status
      • Execution.LoopStatus
      • Execution.id
      • Execution.user
      • Execution.agent
      • Execution.mission
      • Execution.status
      • Execution.result
      • Execution.metadata
      • Execution.iteration
      • Execution.max_iterations
      • Execution.loop_status
      • Execution.next_run_at
      • Execution.loop_decision
      • Execution.created_at
      • Execution.updated_at
      • Execution.threads
      • Execution.DoesNotExist
      • Execution.MultipleObjectsReturned
      • Execution.agent_id
      • Execution.get_loop_status_display()
      • Execution.get_next_by_created_at()
      • Execution.get_next_by_updated_at()
      • Execution.get_previous_by_created_at()
      • Execution.get_previous_by_updated_at()
      • Execution.get_status_display()
      • Execution.mission_id
      • Execution.objects
      • Execution.user_id
    • Thread
      • Thread.id
      • Thread.user
      • Thread.agent
      • Thread.execution
      • Thread.created_at
      • Thread.title
      • Thread.is_active
      • Thread.runs
      • Thread.checkpoints
      • Thread.get_execution()
      • Thread.create_run()
      • Thread.DoesNotExist
      • Thread.MultipleObjectsReturned
      • Thread.agent_id
      • Thread.execution_id
      • Thread.get_next_by_created_at()
      • Thread.get_previous_by_created_at()
      • Thread.objects
      • Thread.user_id
    • Run
      • Run.Status
      • Run.id
      • Run.config
      • Run.thread
      • Run.status
      • Run.error
      • Run.metadata
      • Run.total_tokens
      • Run.created_at
      • Run.updated_at
      • Run.checkpoints
      • Run.get_thread()
      • Run.save_status()
      • Run.last_checkpoint()
      • Run.has_interruption()
      • Run.DoesNotExist
      • Run.MultipleObjectsReturned
      • Run.get_next_by_created_at()
      • Run.get_next_by_updated_at()
      • Run.get_previous_by_created_at()
      • Run.get_previous_by_updated_at()
      • Run.get_status_display()
      • Run.objects
      • Run.thread_id
    • Checkpoint
      • Checkpoint.id
      • Checkpoint.thread
      • Checkpoint.run
      • Checkpoint.namespace
      • Checkpoint.checkpoint_id
      • Checkpoint.parent
      • Checkpoint.ts
      • Checkpoint.data
      • Checkpoint.metadata
      • Checkpoint.new_versions
      • Checkpoint.type
      • Checkpoint.blob
      • Checkpoint.created_at
      • Checkpoint.interruptions
      • Checkpoint.messages
      • Checkpoint.children
      • Checkpoint.deserialize_blob()
      • Checkpoint.get_last_tool_call_message()
      • Checkpoint.get_interruptions()
      • Checkpoint.DoesNotExist
      • Checkpoint.MultipleObjectsReturned
      • Checkpoint.get_next_by_created_at()
      • Checkpoint.get_previous_by_created_at()
      • Checkpoint.objects
      • Checkpoint.parent_id
      • Checkpoint.run_id
      • Checkpoint.thread_id
    • CheckpointWrite
      • CheckpointWrite.id
      • CheckpointWrite.thread_id
      • CheckpointWrite.checkpoint_id
      • CheckpointWrite.checkpoint_ns
      • CheckpointWrite.task_id
      • CheckpointWrite.task_path
      • CheckpointWrite.channel
      • CheckpointWrite.value_type
      • CheckpointWrite.value_blob
      • CheckpointWrite.created_at
      • CheckpointWrite.DoesNotExist
      • CheckpointWrite.MultipleObjectsReturned
      • CheckpointWrite.get_next_by_created_at()
      • CheckpointWrite.get_previous_by_created_at()
      • CheckpointWrite.objects
    • Interruption
      • Interruption.Status
      • Interruption.id
      • Interruption.status
      • Interruption.checkpoint
      • Interruption.priority
      • Interruption.user
      • Interruption.agent
      • Interruption.question
      • Interruption.answer
      • Interruption.data
      • Interruption.created_at
      • Interruption.updated_at
      • Interruption.answered_at
      • Interruption.resumed_at
      • Interruption.get_thread()
      • Interruption.get_to()
      • Interruption.get_from()
      • Interruption.by_id()
      • Interruption.get_message()
      • Interruption.DoesNotExist
      • Interruption.MultipleObjectsReturned
      • Interruption.agent_id
      • Interruption.checkpoint_id
      • Interruption.get_next_by_created_at()
      • Interruption.get_next_by_updated_at()
      • Interruption.get_previous_by_created_at()
      • Interruption.get_previous_by_updated_at()
      • Interruption.get_status_display()
      • Interruption.objects
      • Interruption.user_id
    • Session
      • Session.user
      • Session.data
      • Session.session_key
      • Session.created_at
      • Session.updated_at
      • Session.rooms
      • Session.channel_group_name()
      • Session.DoesNotExist
      • Session.MultipleObjectsReturned
      • Session.get_next_by_created_at()
      • Session.get_next_by_updated_at()
      • Session.get_previous_by_created_at()
      • Session.get_previous_by_updated_at()
      • Session.id
      • Session.objects
      • Session.user_id
    • Room
      • Room.name
      • Room.created_at
      • Room.updated_at
      • Room.sessions
      • Room.messages
      • Room.DoesNotExist
      • Room.MultipleObjectsReturned
      • Room.get_next_by_created_at()
      • Room.get_next_by_updated_at()
      • Room.get_previous_by_created_at()
      • Room.get_previous_by_updated_at()
      • Room.id
      • Room.objects
    • Message
      • Message.MAX_CONTENT
      • Message.Role
      • Message.AlreadyExists
      • Message.id
      • Message.role
      • Message.user
      • Message.room
      • Message.agent
      • Message.checkpoint
      • Message.content
      • Message.think
      • Message.created_at
      • Message.importance
      • Message.reply_to
      • Message.metadata
      • Message.tool_calls
      • Message.get_type_from_role()
      • Message.get_role_from_type()
      • Message.register_checkpoint_message()
      • Message.get_messages_until_checkpoint()
      • Message.to_message()
      • Message.DoesNotExist
      • Message.MultipleObjectsReturned
      • Message.agent_id
      • Message.checkpoint_id
      • Message.get_next_by_created_at()
      • Message.get_previous_by_created_at()
      • Message.get_role_display()
      • Message.objects
      • Message.replies
      • Message.reply_to_id
      • Message.room_id
      • Message.user_id
    • UserPreferences
      • UserPreferences.user
      • UserPreferences.active_workspace
      • UserPreferences.active_agent
      • UserPreferences.active_thread
      • UserPreferences.system_voice
      • UserPreferences.desktop
      • UserPreferences.language
      • UserPreferences.timezone
      • UserPreferences.updated_at
      • UserPreferences.to_api()
      • UserPreferences.for_user()
      • UserPreferences.DoesNotExist
      • UserPreferences.MultipleObjectsReturned
      • UserPreferences.active_agent_id
      • UserPreferences.active_thread_id
      • UserPreferences.active_workspace_id
      • UserPreferences.get_next_by_updated_at()
      • UserPreferences.get_previous_by_updated_at()
      • UserPreferences.objects
      • UserPreferences.system_voice_id
      • UserPreferences.user_id
    • Photo
      • Photo.Origin
      • Photo.id
      • Photo.user
      • Photo.file
      • Photo.title
      • Photo.origin
      • Photo.source
      • Photo.created_at
      • Photo.updated_at
      • Photo.DoesNotExist
      • Photo.MultipleObjectsReturned
      • Photo.get_next_by_created_at()
      • Photo.get_next_by_updated_at()
      • Photo.get_origin_display()
      • Photo.get_previous_by_created_at()
      • Photo.get_previous_by_updated_at()
      • Photo.objects
      • Photo.user_id
    • UiPanel
      • UiPanel.Scope
      • UiPanel.id
      • UiPanel.owner
      • UiPanel.workspace
      • UiPanel.scope
      • UiPanel.title
      • UiPanel.channel
      • UiPanel.document
      • UiPanel.created_at
      • UiPanel.updated_at
      • UiPanel.DoesNotExist
      • UiPanel.MultipleObjectsReturned
      • UiPanel.get_next_by_created_at()
      • UiPanel.get_next_by_updated_at()
      • UiPanel.get_previous_by_created_at()
      • UiPanel.get_previous_by_updated_at()
      • UiPanel.get_scope_display()
      • UiPanel.objects
      • UiPanel.owner_id
      • UiPanel.workspace_id
  • Agent runtime (module)
    • State
      • State.question
      • State.answer
      • State.docs
    • Configurable
      • Configurable.__init__()
      • Configurable.checkpoint_id
      • Configurable.checkpoint_ns
    • CheckpointSaver
      • CheckpointSaver.__init__()
      • CheckpointSaver.put()
      • CheckpointSaver.put_writes()
      • CheckpointSaver.get_tuple()
    • TokenUsage
      • TokenUsage.__init__()
      • TokenUsage.total
      • TokenUsage.input
      • TokenUsage.output
    • RunMiddleware
      • RunMiddleware.__init__()
      • RunMiddleware.run
      • RunMiddleware.saved_message_ids
      • RunMiddleware.presence
      • RunMiddleware.before_agent()
      • RunMiddleware.check_new_message()
      • RunMiddleware.wrap_model_call()
      • RunMiddleware.wrap_tool_call()
      • RunMiddleware.after_agent()
    • ThreadRunner
      • ThreadRunner.__init__()
      • ThreadRunner.presence
      • ThreadRunner.resolve_model()
      • ThreadRunner.create_graph()
      • ThreadRunner.run()
      • ThreadRunner.resume()
      • ThreadRunner.continue_turn()
      • ThreadRunner.invoke()
      • ThreadRunner.check_interrupt()
  • Tasks
  • Tools
    • Basic
    • Web
    • Help / documentation
      • singlehtml_path()
      • parse_help_sections()
      • read_agency_help_text()
    • Database
      • DatabaseSchemaGenerator
      • DatabaseReadTool
    • Agent
    • Human
    • Python interpreter
      • warn_once()
      • PythonREPL
      • sanitize_input()
      • PythonREPLTool
      • PythonInputs
      • PythonAstREPLTool
    • Icons
    • Pictures
    • Secretary
    • Display
  • Miner
    • Scrap
      • Scrap.id
      • Scrap.url
      • Scrap.created_at
      • Scrap.updated_at
      • Scrap.status
      • Scrap.error
      • Scrap.data
      • Scrap.headers
      • Scrap.cookies
      • Scrap.DoesNotExist
      • Scrap.MultipleObjectsReturned
      • Scrap.blocks
      • Scrap.get_next_by_created_at()
      • Scrap.get_next_by_updated_at()
      • Scrap.get_previous_by_created_at()
      • Scrap.get_previous_by_updated_at()
      • Scrap.objects
    • Block
      • Block.id
      • Block.scrap
      • Block.content
      • Block.metadata
      • Block.created_at
      • Block.updated_at
      • Block.DoesNotExist
      • Block.MultipleObjectsReturned
      • Block.get_next_by_created_at()
      • Block.get_next_by_updated_at()
      • Block.get_previous_by_created_at()
      • Block.get_previous_by_updated_at()
      • Block.objects
      • Block.scrap_id
  • Channels
    • publish_event()
    • channel_log()
    • channel_run()
    • channel_user()
    • Publisher
      • Publisher.__init__()
      • Publisher.send()
      • Publisher.group_send()
      • Publisher.send_to_groups()
      • Publisher.consumer_handle()
    • Philosophy
    • Groups
      • Groups.__init__()
    • Messenger
      • Messenger.ICON_MAP
      • Messenger.__init__()
      • Messenger.stream()
    • Monitor
      • Monitor.Event
      • Monitor.__init__()
      • Monitor.emit()
    • Catalog
      • Catalog.GROUPS
      • Catalog.emit()
  • API
    • serializer()
    • provider_serializer()
    • model_serializer()
    • agent_serializer()
    • agent_view_set()
    • mission_serializer()
    • mission_view_set()
    • execution_serializer()
    • task_view_set()
    • execution_view_set()
    • SystemInfo
      • SystemInfo.permission_classes
      • SystemInfo.schema
      • SystemInfo.get()
      • SystemInfo.options()
    • Version
      • Version.schema
      • Version.get()
    • MePrefs
      • MePrefs.permission_classes
      • MePrefs.schema
      • MePrefs.get()
      • MePrefs.patch()
    • MeMedia
      • MeMedia.permission_classes
      • MeMedia.schema
      • MeMedia.get()
      • MeMedia.put()
    • view_set()
    • agent_test()
    • mission_dispatch()
    • interruption_view_set()
    • tool_serializer()
    • tool_view_set()
    • photo_serializer()
    • photo_view_set()
    • tool_sync()
    • provider_sync()
    • workspace_serializer()
    • document_serializer()
    • workspace_view_set()
    • document_view_set()
    • document_reindex()
    • document_extraction()
    • workspace_search()
    • workspace_ask()
    • user_serializer()
    • user_view_set()
    • group_serializer()
    • group_view_set()
    • UserPrefsStaff
      • UserPrefsStaff.permission_classes
      • UserPrefsStaff.schema
      • UserPrefsStaff.get()
      • UserPrefsStaff.patch()
      • UserPrefsStaff.options()
    • api_index()
    • router
  • Module Index
  • Index
Agency
  • Index

Index – F

  • FAILED (agency.corpus.models.Document.Status attribute)
    • (agency.models.Execution.LoopStatus attribute)
  • FAILURE (agency.models.Task.State attribute)
  • FAL (agency.models.Provider.Kind attribute)
  • family (agency.models.Model attribute)
  • file (agency.corpus.models.Document attribute)
    • (agency.models.Photo attribute)
  • for_user() (agency.models.UserPreferences class method)
  • format (agency.models.Model attribute)

© Copyright 2025-2026, Nabla Soluciones Lógicas, S.L..

Built with Sphinx using a theme provided by Read the Docs.