API

REST endpoints for managing agents and executions:

API views for the agency app.

agency.api.views.serializer(cls)

Get the default model serializer.

Parameters:

cls – Model class to create serializer for

Returns:

ModelSerializer class for the given model

agency.api.views.provider_serializer()

Provider row plus key/sync hints (never the secret itself).

agency.api.views.model_serializer()

Model row with temperature / num_ctx mirrored from metadata.

agency.api.views.agent_serializer()

Agent serializer with nested model/tools for explorers and M2M write.

agency.api.views.agent_view_set()

CRUD viewset for Agent with prefetch for explorer cards.

agency.api.views.mission_serializer()

Mission serializer with loop fields and read-only is_loop.

agency.api.views.mission_view_set()

agency.api.views.execution_serializer()

List/detail serializers for Execution (Mission Control explorers).

agency.api.views.task_view_set()

List/retrieve Celery tasks (newest first for the UI monitor).

agency.api.views.execution_view_set()

List/retrieve Execution with nested Result payload on retrieve.

class agency.api.views.SystemInfo(**kwargs)

Bases: APIView

Host versions plus inference (Ollama GPUs, ComfyUI) when deployed.

permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>]

schema

get(request)

options(request, *args, **kwargs)

Handler method for HTTP ‘OPTIONS’ request.

class agency.api.views.Version(**kwargs)

Bases: APIView

Returns version and system information.

schema

get(request)

class agency.api.views.MePrefs(**kwargs)

Bases: APIView

Current user’s Mission Control preferences (workspace + Desktop).

permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>]

schema

get(request)

patch(request)

class agency.api.views.MeMedia(**kwargs)

Bases: APIView

Operator Media now-playing for secretary tools (not a bus producer).

permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>]

schema

get(request)

put(request)

agency.api.views.view_set(cls, edit=None, actions=None, serializer_class=None)

Get the default model view set.

Parameters:

• cls – Model class to create viewset for

• edit – If False, only list/retrieve. If True, full CRUD. If None, uses actions.

• actions – List of action names to include (e.g., [‘list’, ‘create’])

• serializer_class – Optional custom serializer class. If None, uses default serializer.

Returns:

ViewSet class for the given model

agency.api.views.agent_test(request, *args, **kwargs)

Test an agent with a message.

Parameters:

• request – HTTP request object

• agent_id – UUID of the agent to test

Returns:

Response with agent test result or error message

agency.api.views.mission_dispatch(request, *args, **kwargs)

Dispatch a mission with an agent.

Parameters:

• request – HTTP request object with agent_id in body

• mission_id – UUID of the mission to dispatch

Returns:

Response with execution_id, thread_id, and task_id

agency.api.views.interruption_view_set()

Pending HITL list with agent display name.

agency.api.views.tool_serializer()

Tool serializer with optional uploaded icon (multipart).

agency.api.views.tool_view_set()

CRUD viewset for Tool with multipart icon uploads.

agency.api.views.photo_serializer()

Photo serializer: multipart file + catalog card fields.

agency.api.views.photo_view_set()

User-scoped photo library (uploads + generated).

agency.api.views.tool_sync(request, *args, **kwargs)

Sync Tool rows from agency.tools code exports.

agency.api.views.provider_sync(request, *args, **kwargs)

Sync models from a provider API into local Model rows.

agency.api.views.workspace_serializer()

agency.api.views.document_serializer()

agency.api.views.workspace_view_set()

agency.api.views.document_view_set()

agency.api.views.document_reindex(request, *args, **kwargs)

Queue Celery index_document for an existing document.

agency.api.views.document_extraction(request, *args, **kwargs)

Latest extraction: pages + chunk previews (admin-parity).

agency.api.views.workspace_search(request, *args, **kwargs)

Similarity search against the workspace Chroma collection.

agency.api.views.workspace_ask(request, *args, **kwargs)

RAG ask: retrieve + LLM answer with source nodes.

agency.api.views.user_serializer()

User serializer for staff explorer (no password hash exposure).

agency.api.views.user_view_set()

Staff-only User list/retrieve/update viewset.

agency.api.views.group_serializer()

Group serializer with permission ids.

agency.api.views.group_view_set()

Staff-only Group list/create/update viewset.

class agency.api.views.UserPrefsStaff(**kwargs)

Bases: APIView

Staff-only access to any user’s preferences.

permission_classes = [<class 'rest_framework.permissions.IsAdminUser'>]

schema

get(request, user_id)

patch(request, user_id)

options(request, *args, **kwargs)

Handler method for HTTP ‘OPTIONS’ request.

Agency API urls definition.

agency.api.urls.api_index(request, *args, **kwargs)

Default API index page.

agency.api.urls.router = <rest_framework.routers.SimpleRouter object>

DRF router for the API endpoints.