|
| 1 | +# Welcome to Julep - Julep |
| 2 | + |
| 3 | +> Welcome to Julep |
| 4 | + |
| 5 | + |
| 6 | +## Getting Started with Julep |
| 7 | +- [Welcome to Julep - Julep](https://docs.julep.ai/): Welcome to Julep |
| 8 | +- [Chat with an Agent - Julep](https://docs.julep.ai/guides/getting-started/chat-with-an-agent): Learn how to chat with your agent |
| 9 | +- [Create & Execute a Julep Task - Julep](https://docs.julep.ai/guides/getting-started/create-and-execute-julep-task): Learn how to create and execute a Julep task |
| 10 | +- [Tool Integration Demo - Julep](https://docs.julep.ai/guides/getting-started/tool-integration-demo): Learn how to integrate tools with your Julep agent |
| 11 | + |
| 12 | +## Julep Concepts |
| 13 | +- [Agents - Julep](https://docs.julep.ai/concepts/agents): Understanding Julep Agents and their capabilities |
| 14 | +- [Documents (RAG) - Julep](https://docs.julep.ai/concepts/docs): Working with documents in Julep |
| 15 | +- [Executions - Julep](https://docs.julep.ai/concepts/execution): Understanding Task Executions and Their Lifecycle |
| 16 | +- [Files - Julep](https://docs.julep.ai/concepts/files): Managing files and attachments in Julep |
| 17 | +- [Projects - Julep](https://docs.julep.ai/concepts/projects): Organizational units for grouping related resources |
| 18 | +- [Secrets - Julep](https://docs.julep.ai/concepts/secrets): Securely store and manage sensitive information for your LLM applications |
| 19 | +- [Sessions - Julep](https://docs.julep.ai/concepts/sessions): Understanding Julep Sessions and state management |
| 20 | +- [Tasks - Julep](https://docs.julep.ai/concepts/tasks): Understanding Julep Tasks and workflows |
| 21 | +- [Tools - Julep](https://docs.julep.ai/concepts/tools): Understanding tools in Julep |
| 22 | +- [Users - Julep](https://docs.julep.ai/concepts/users): Understanding and Managing Users in Julep |
| 23 | + |
| 24 | +## Advanced Features |
| 25 | +- [Agentic Patterns - Julep](https://docs.julep.ai/advanced/agentic-patterns): Learn about common patterns and best practices for building Julep agents |
| 26 | +- [Architecture Deep Dive - Julep](https://docs.julep.ai/advanced/architecture-deep-dive): Understand the core architecture and components of Julep |
| 27 | +- [Chat Features in Julep - Julep](https://docs.julep.ai/advanced/chat): Learn about the robust chat system and its various features for dynamic interaction with agents |
| 28 | +- [Files (Multimedia) - Julep](https://docs.julep.ai/advanced/files): Learn about file handling and management in Julep |
| 29 | +- [Execution Lifecycle - Julep](https://docs.julep.ai/advanced/lifecycle): Understanding the Lifecycle of Task when executed in Julep |
| 30 | +- [Local Setup - Julep](https://docs.julep.ai/advanced/localsetup): Learn how to run Julep locally |
| 31 | +- [Multi-Agent Multi-User Sessions - Julep](https://docs.julep.ai/advanced/multi-agent-multi-user-sessions): Learn how to manage complex multi-agent systems with multiple users |
| 32 | +- [New Syntax (Important) - Julep](https://docs.julep.ai/advanced/new-syntax): Learn about the new workflow syntax and how to migrate your existing workflows |
| 33 | +- [Python Expression - Julep](https://docs.julep.ai/advanced/python-expression): Learn how to use Python expressions in Julep task definitions |
| 34 | +- [Render Endpoint in Julep - Julep](https://docs.julep.ai/advanced/render): Learn about the render endpoint for previewing chat inputs before sending them to the model |
| 35 | +- [Secrets Management - Julep](https://docs.julep.ai/advanced/secrets-management): Advanced techniques for managing sensitive information in Julep |
| 36 | +- [Types of Task Steps - Julep](https://docs.julep.ai/advanced/types-of-task-steps): Learn about different types of task steps and their use |
| 37 | + |
| 38 | +## API Reference - Agents |
| 39 | +- [Create Agent - Julep](https://docs.julep.ai/api-reference/agents/create-agent): Create Agent |
| 40 | +- [Create Agent Tool - Julep](https://docs.julep.ai/api-reference/agents/create-agent-tool): Create Agent Tool |
| 41 | +- [Create Or Update Agent - Julep](https://docs.julep.ai/api-reference/agents/create-or-update-agent): Create Or Update Agent |
| 42 | +- [Delete Agent - Julep](https://docs.julep.ai/api-reference/agents/delete-agent): Delete Agent |
| 43 | +- [Delete Agent Tool - Julep](https://docs.julep.ai/api-reference/agents/delete-agent-tool): Delete Agent Tool |
| 44 | +- [Get Agent Details - Julep](https://docs.julep.ai/api-reference/agents/get-agent-details): Get Agent Details |
| 45 | +- [List Agent Tools - Julep](https://docs.julep.ai/api-reference/agents/list-agent-tools): List Agent Tools |
| 46 | +- [List Agents - Julep](https://docs.julep.ai/api-reference/agents/list-agents): List Agents |
| 47 | +- [List Models - Julep](https://docs.julep.ai/api-reference/agents/list-models): List all available models that can be used with agents. Returns: ListModelsResponse: A list of available models |
| 48 | +- [Patch Agent - Julep](https://docs.julep.ai/api-reference/agents/patch-agent): Patch Agent |
| 49 | +- [Patch Agent Tool - Julep](https://docs.julep.ai/api-reference/agents/patch-agent-tool): Patch Agent Tool |
| 50 | +- [Update Agent - Julep](https://docs.julep.ai/api-reference/agents/update-agent): Update Agent |
| 51 | +- [Update Agent Tool - Julep](https://docs.julep.ai/api-reference/agents/update-agent-tool): Update Agent Tool |
| 52 | + |
| 53 | +## API Reference - Documents |
| 54 | +- [Bulk Delete Agent Docs - Julep](https://docs.julep.ai/api-reference/docs/bulk-delete-agent-docs): Bulk delete documents owned by an agent based on metadata filter |
| 55 | +- [Bulk Delete User Docs - Julep](https://docs.julep.ai/api-reference/docs/bulk-delete-user-docs): Bulk delete documents owned by a user based on metadata filter |
| 56 | +- [Create Agent Doc - Julep](https://docs.julep.ai/api-reference/docs/create-agent-doc): Create Agent Doc |
| 57 | +- [Create User Doc - Julep](https://docs.julep.ai/api-reference/docs/create-user-doc): Creates a new document for a user. Parameters: user_id (UUID): The unique identifier of the user associated with the document. data (CreateDocRequest): The data to create the document with. x_developer_id (UUID): The unique identifier of the developer associated with the document. Returns: Doc: The created document. |
| 58 | +- [Delete Agent Doc - Julep](https://docs.julep.ai/api-reference/docs/delete-agent-doc): Delete Agent Doc |
| 59 | +- [Delete User Doc - Julep](https://docs.julep.ai/api-reference/docs/delete-user-doc): Delete User Doc |
| 60 | +- [Embed - Julep](https://docs.julep.ai/api-reference/docs/embed): Embed |
| 61 | +- [Get Doc - Julep](https://docs.julep.ai/api-reference/docs/get-doc): Get Doc |
| 62 | +- [List Agent Docs - Julep](https://docs.julep.ai/api-reference/docs/list-agent-docs): List Agent Docs |
| 63 | +- [List User Docs - Julep](https://docs.julep.ai/api-reference/docs/list-user-docs): List User Docs |
| 64 | +- [Search Agent Docs - Julep](https://docs.julep.ai/api-reference/docs/search-agent-docs): Searches for documents associated with a specific agent. Parameters: x_developer_id (UUID): The unique identifier of the developer associated with the agent. search_params (TextOnlyDocSearchRequest | VectorDocSearchRequest | HybridDocSearchRequest): The parameters for the search. agent_id (UUID): The unique identifier of the agent associated with the documents. Returns: DocSearchResponse: The search results. |
| 65 | +- [Search User Docs - Julep](https://docs.julep.ai/api-reference/docs/search-user-docs): Searches for documents associated with a specific user. Parameters: x_developer_id (UUID): The unique identifier of the developer associated with the user. search_params (TextOnlyDocSearchRequest | VectorDocSearchRequest | HybridDocSearchRequest): The parameters for the search. user_id (UUID): The unique identifier of the user associated with the documents. Returns: DocSearchResponse: The search results. |
| 66 | + |
| 67 | +## API Reference - Executions |
| 68 | +- [Create Task Execution - Julep](https://docs.julep.ai/api-reference/executions/create-task-execution): Create Task Execution |
| 69 | +- [Get Execution Details - Julep](https://docs.julep.ai/api-reference/executions/get-execution-details): Get Execution Details |
| 70 | +- [List Execution Transitions - Julep](https://docs.julep.ai/api-reference/executions/list-execution-transitions): List Execution Transitions |
| 71 | +- [Stream Execution Status - Julep](https://docs.julep.ai/api-reference/executions/stream-execution-status): SSE endpoint that streams the status of a given execution_id by polling the latest_executions view. |
| 72 | +- [Stream Transitions Events - Julep](https://docs.julep.ai/api-reference/executions/stream-transitions-events): Stream Transitions Events |
| 73 | +- [Update Execution - Julep](https://docs.julep.ai/api-reference/executions/update-execution): Update Execution |
| 74 | + |
| 75 | +## API Reference - Files |
| 76 | +- [Create File - Julep](https://docs.julep.ai/api-reference/files/create-file): Create File |
| 77 | +- [Delete File - Julep](https://docs.julep.ai/api-reference/files/delete-file): Delete File |
| 78 | +- [Get File - Julep](https://docs.julep.ai/api-reference/files/get-file): Get File |
| 79 | +- [List Files - Julep](https://docs.julep.ai/api-reference/files/list-files): List Files |
| 80 | + |
| 81 | +## API Reference - Health |
| 82 | +- [Check Health - Julep](https://docs.julep.ai/api-reference/healthz/check-health): Check Health |
| 83 | + |
| 84 | +## API Reference - Jobs |
| 85 | +- [Get Job Status - Julep](https://docs.julep.ai/api-reference/jobs/get-job-status): Get Job Status |
| 86 | + |
| 87 | +## API Reference - Projects |
| 88 | +- [Create Project - Julep](https://docs.julep.ai/api-reference/projects/create-project): Create Project |
| 89 | +- [List Projects - Julep](https://docs.julep.ai/api-reference/projects/list-projects): List Projects |
| 90 | + |
| 91 | +## API Reference - Secrets |
| 92 | +- [Create Developer Secret - Julep](https://docs.julep.ai/api-reference/secrets/create-developer-secret): Create a new secret for a developer. Args: developer_id: ID of the developer creating the secret secret: Secret to create Returns: The created secret Raises: HTTPException: If a secret with this name already exists (409 Conflict) |
| 93 | +- [Delete Developer Secret - Julep](https://docs.julep.ai/api-reference/secrets/delete-developer-secret): Delete a secret. Args: secret_id: ID of the secret to delete x_developer_id: ID of the developer who owns the secret Returns: The deleted secret Raises: HTTPException: If the secret doesn't exist |
| 94 | +- [List Developer Secrets - Julep](https://docs.julep.ai/api-reference/secrets/list-developer-secrets): List all secrets for a developer. Args: x_developer_id: ID of the developer whose secrets to list limit: Maximum number of secrets to return offset: Number of secrets to skip Returns: List of secrets |
| 95 | +- [Update Developer Secret - Julep](https://docs.julep.ai/api-reference/secrets/update-developer-secret): Update a developer secret. Args: developer_id: ID of the developer who owns the secret secret_id: ID of the secret to update data: New secret data Returns: The updated secret Raises: HTTPException: If the secret doesn't exist or doesn't belong to the developer |
| 96 | + |
| 97 | +## API Reference - Sessions |
| 98 | +- [Chat - Julep](https://docs.julep.ai/api-reference/sessions/chat): Initiates a chat session. Parameters: developer (Developer): The developer associated with the chat session. session_id (UUID): The unique identifier of the chat session. chat_input (ChatInput): The chat input data. background_tasks (BackgroundTasks): The background tasks to run. x_custom_api_key (Optional[str]): The custom API key. Returns: ChatResponse: The chat response. |
| 99 | +- [Create Or Update Session - Julep](https://docs.julep.ai/api-reference/sessions/create-or-update-session): Create Or Update Session |
| 100 | +- [Create Session - Julep](https://docs.julep.ai/api-reference/sessions/create-session): Create Session |
| 101 | +- [Delete Session - Julep](https://docs.julep.ai/api-reference/sessions/delete-session): Delete Session |
| 102 | +- [Get Session - Julep](https://docs.julep.ai/api-reference/sessions/get-session): Get Session |
| 103 | +- [Get Session History - Julep](https://docs.julep.ai/api-reference/sessions/get-session-history): Get Session History |
| 104 | +- [List Sessions - Julep](https://docs.julep.ai/api-reference/sessions/list-sessions): List Sessions |
| 105 | +- [Patch Session - Julep](https://docs.julep.ai/api-reference/sessions/patch-session): Patch Session |
| 106 | +- [Render - Julep](https://docs.julep.ai/api-reference/sessions/render): Renders a chat input. Parameters: developer (Developer): The developer associated with the chat session. session_id (UUID): The unique identifier of the chat session. chat_input (ChatInput): The chat input data. Returns: RenderResponse: The rendered chat input. |
| 107 | +- [Update Session - Julep](https://docs.julep.ai/api-reference/sessions/update-session): Update Session |
| 108 | + |
| 109 | +## API Reference - Tasks |
| 110 | +- [Create Or Update Task - Julep](https://docs.julep.ai/api-reference/tasks/create-or-update-task): Create Or Update Task |
| 111 | +- [Create Task - Julep](https://docs.julep.ai/api-reference/tasks/create-task): Create Task |
| 112 | +- [Get Execution Transition - Julep](https://docs.julep.ai/api-reference/tasks/get-execution-transition): Get Execution Transition |
| 113 | +- [Get Task Details - Julep](https://docs.julep.ai/api-reference/tasks/get-task-details): Get Task Details |
| 114 | +- [List Task Executions - Julep](https://docs.julep.ai/api-reference/tasks/list-task-executions): List Task Executions |
| 115 | +- [List Tasks - Julep](https://docs.julep.ai/api-reference/tasks/list-tasks): List Tasks |
| 116 | + |
| 117 | +## Optional |
| 118 | +- [Adding a Tool Integration - Julep](https://docs.julep.ai/guides/adding-tool-integration): Extend Julep with your own tool or API |
| 119 | +- [Complex Workflows - Julep](https://docs.julep.ai/guides/advanced/complex-workflows): Creating advanced task workflows |
| 120 | +- [Integration Patterns - Julep](https://docs.julep.ai/guides/advanced/integration-patterns): Common patterns for integrating with external services |
| 121 | +- [Multi-Agent Systems - Julep](https://docs.julep.ai/guides/advanced/multi-agent-systems): Building complex multi-agent systems |
| 122 | +- [Community Examples - Julep](https://docs.julep.ai/guides/cookbooks/community-examples): Examples from the Julep community |
| 123 | +- [Quick Solutions - Julep](https://docs.julep.ai/guides/cookbooks/quick-solutions): Ready-to-use solutions for common use cases |
| 124 | +- [Modifying Agent Workflow - Julep](https://docs.julep.ai/guides/modifying-agent-workflow): Customize how your agents process tasks |
| 125 | + |
| 126 | +--- |
| 127 | + |
| 128 | +*This llms.txt file was generated by [llmtxt.dev](https://llmtxt.dev)* |
0 commit comments