# Friday

## Docs

- [Get agent details](https://docs.hellofriday.ai/api-reference/agents/get-agent-details.md): Get detailed information about a specific agent.
- [List agents](https://docs.hellofriday.ai/api-reference/agents/list-agents.md): List all available agents.
- [Delete artifact](https://docs.hellofriday.ai/api-reference/artifacts/delete-artifact.md): Soft-delete an artifact.
- [Get artifact](https://docs.hellofriday.ai/api-reference/artifacts/get-artifact.md): Get an artifact by ID with inline contents or database preview.
- [List artifacts](https://docs.hellofriday.ai/api-reference/artifacts/list-artifacts.md): List artifacts with optional filtering by space or chat.
- [Upload file as artifact](https://docs.hellofriday.ai/api-reference/artifacts/upload-file-as-artifact.md): Upload a file and convert it to an artifact.
- [Send a chat message](https://docs.hellofriday.ai/api-reference/chat/send-a-chat-message.md): Send a message to a space and receive a streaming response via Server-Sent Events.
- [Get environment config](https://docs.hellofriday.ai/api-reference/configuration/get-environment-config.md): Get environment variables from the daemon's configuration.
- [Update environment config](https://docs.hellofriday.ai/api-reference/configuration/update-environment-config.md): Update environment variables in the daemon's configuration.
- [Get daemon status](https://docs.hellofriday.ai/api-reference/health/get-daemon-status.md): Get detailed daemon status including memory usage and active spaces.
- [Health check](https://docs.hellofriday.ai/api-reference/health/health-check.md): Check if the Friday daemon is running and get basic status information.
- [API reference](https://docs.hellofriday.ai/api-reference/introduction.md): The Friday daemon HTTP API for managing spaces, agents, sessions, and automations.
- [Cancel session](https://docs.hellofriday.ai/api-reference/sessions/cancel-session.md): Cancel a running session.
- [Get session](https://docs.hellofriday.ai/api-reference/sessions/get-session.md): Get details of a specific session.
- [List sessions](https://docs.hellofriday.ai/api-reference/sessions/list-sessions.md): List all session summaries, optionally filtered by space.
- [Trigger a signal](https://docs.hellofriday.ai/api-reference/signals/trigger-a-signal.md): Manually trigger a signal in a space. Returns JSON by default, or an SSE stream if `Accept: text/event-stream` is set.
- [Create a space](https://docs.hellofriday.ai/api-reference/spaces/create-a-space.md): Create a new space from a configuration object. Creates the directory and files.
- [Delete a space](https://docs.hellofriday.ai/api-reference/spaces/delete-a-space.md): Delete a registered space.
- [Get space details](https://docs.hellofriday.ai/api-reference/spaces/get-space-details.md): Get a space's details and configuration.
- [List spaces](https://docs.hellofriday.ai/api-reference/spaces/list-spaces.md): List all registered spaces sorted by name.
- [Register a space](https://docs.hellofriday.ai/api-reference/spaces/register-a-space.md): Register a space by providing the path to a directory containing a `workspace.yml` file.
- [Agents](https://docs.hellofriday.ai/core-concepts/agents.md): Built-in and custom agents that execute operations in your agentic workflows.
- [API](https://docs.hellofriday.ai/core-concepts/api.md): The Friday daemon — the backend service that powers spaces, agents, and sessions.
- [Architecture](https://docs.hellofriday.ai/core-concepts/architecture.md): High-level overview of the components that make up Friday.
- [CLI](https://docs.hellofriday.ai/core-concepts/cli.md): The friday command-line tool for managing spaces, agents, signals, and the Friday daemon.
- [Overview](https://docs.hellofriday.ai/core-concepts/communicators.md): Connect Friday to chat platforms — Slack, Discord, Telegram, WhatsApp, Microsoft Teams.
- [Discord](https://docs.hellofriday.ai/core-concepts/communicators/discord.md): Connect a Discord bot to a workspace for DMs and @mentions.
- [Slack](https://docs.hellofriday.ai/core-concepts/communicators/slack.md): Connect a Slack app to a workspace for DMs and @mentions.
- [Microsoft Teams](https://docs.hellofriday.ai/core-concepts/communicators/teams.md): Connect a Microsoft Teams bot to a workspace for DMs and @mentions.
- [Telegram](https://docs.hellofriday.ai/core-concepts/communicators/telegram.md): Connect a Telegram bot to a workspace for direct messages.
- [WhatsApp](https://docs.hellofriday.ai/core-concepts/communicators/whatsapp.md): Connect a WhatsApp Business number to a workspace for customer chat.
- [Jobs](https://docs.hellofriday.ai/core-concepts/jobs.md): FSM-based workflows that orchestrate agents step by step.
- [MCP Tools](https://docs.hellofriday.ai/core-concepts/mcp.md): Connect agents to external systems via Model Context Protocol servers.
- [Memory](https://docs.hellofriday.ai/core-concepts/memory.md): Persistent state that accumulates across sessions and auto-injects into agent context.
- [Overview](https://docs.hellofriday.ai/core-concepts/signals.md): Triggers that start jobs — HTTP webhooks, cron schedules, and filesystem events.
- [Filesystem](https://docs.hellofriday.ai/core-concepts/signals/fs-watch.md): Trigger jobs when files or directories change on disk.
- [HTTP](https://docs.hellofriday.ai/core-concepts/signals/http.md): Webhook signals for external services (GitHub, Bitbucket, Jira) and programmatic triggers.
- [Schedule](https://docs.hellofriday.ai/core-concepts/signals/schedule.md): Cron-based signals that fire jobs on a timer.
- [Spaces](https://docs.hellofriday.ai/core-concepts/spaces.md): Top-level containers for your agents, jobs, and signals — driven by workspace.yml.
- [Quickstart](https://docs.hellofriday.ai/getting-started/quickstart.md): Get Friday Studio running and trigger your first agentic workflow.
- [Call Friday from your app](https://docs.hellofriday.ai/guides/integrate-with-your-app.md): Trigger a workflow, stream its progress, and retrieve results — all from your own application.
- [Friday Studio](https://docs.hellofriday.ai/index.md): An AI agent orchestration platform — chat to build, signals to trigger, agents to execute.
- [Generate text and objects](https://docs.hellofriday.ai/sdk/guides/call-llms.md): Route LLM calls through Friday's provider registry instead of importing API clients directly.
- [Extract structured data](https://docs.hellofriday.ai/sdk/guides/handle-structured-input.md): Extract JSON configurations from Friday's enriched prompts using parse_input() and parse_operation().
- [Fetch HTTP APIs](https://docs.hellofriday.ai/sdk/guides/make-http-requests.md): Make outbound HTTP requests through Friday's fetch layer — TLS, timeouts, and audit logging handled by Friday.
- [Emit progress events](https://docs.hellofriday.ai/sdk/guides/stream-progress.md): Emit progress events that appear in Friday's UI during long-running operations.
- [Call MCP tools](https://docs.hellofriday.ai/sdk/guides/use-mcp-tools.md): Configure MCP servers in your agent decorator and call tools via ctx.tools.
- [How agents work](https://docs.hellofriday.ai/sdk/how-agents-work.md): The subprocess model, host capabilities, and registration flow.
- [Agent SDK](https://docs.hellofriday.ai/sdk/overview.md): Build custom agents that integrate with Friday's runtime and tool ecosystem.
- [Overview](https://docs.hellofriday.ai/sdk/python.md): Write Friday agents in Python using the friday-agent-sdk package.
- [AgentContext](https://docs.hellofriday.ai/sdk/python-reference/agent-context.md): Execution context passed to agent handlers, providing access to environment, capabilities, and metadata.
- [@agent Decorator](https://docs.hellofriday.ai/sdk/python-reference/agent-decorator.md): Registers a function as a Friday agent with metadata for discovery and execution.
- [ctx.http](https://docs.hellofriday.ai/sdk/python-reference/http-capability.md): HTTP capability wrapper for outbound requests through Friday's fetch layer.
- [ctx.llm](https://docs.hellofriday.ai/sdk/python-reference/llm-capability.md): LLM capability wrapper for routing generation requests through Friday's provider registry.
- [Parse Utilities](https://docs.hellofriday.ai/sdk/python-reference/parse-utilities.md): Extract structured JSON from enriched prompts sent by Friday.
- [Result Types](https://docs.hellofriday.ai/sdk/python-reference/result-types.md): Tagged union results for agent handler returns.
- [ctx.stream](https://docs.hellofriday.ai/sdk/python-reference/stream-capability.md): Stream capability wrapper for emitting progress events and intents to the Friday UI.
- [ctx.tools](https://docs.hellofriday.ai/sdk/python-reference/tools-capability.md): MCP tool capability wrapper for invoking Model Context Protocol servers.
- [Quickstart](https://docs.hellofriday.ai/sdk/quickstart.md): Build a text analysis agent from an empty directory to a running result.
- [Security](https://docs.hellofriday.ai/security.md): How Friday Studio handles your data, credentials, and vulnerabilities.
- [Agent Tester](https://docs.hellofriday.ai/tools/agent-tester.md): Test any agent in isolation with different inputs, models, and configurations before wiring into workflows.
- [Job Inspector](https://docs.hellofriday.ai/tools/job-inspector.md): Debug pipeline executions with DAG (Directed Acyclic Graph) visualization and waterfall timelines.
- [Skills](https://docs.hellofriday.ai/tools/skills.md): Structured instruction sets that give agents the context they need to produce consistent, high-quality output.
- [Studio](https://docs.hellofriday.ai/tools/studio.md): The local web dashboard for managing spaces, viewing runs, editing configurations, and browsing skills.

## OpenAPI Specs

- [openapi](https://docs.hellofriday.ai/api-reference/openapi.json)

## Optional

- [Join our community](https://discord.com/invite/uczJyp5FMH)
- [GitHub](https://github.com/friday-platform)
- [Contact us](mailto:hello@hellofriday.ai)