api.md

Shared Types

from julep.types import ResourceCreated, ResourceDeleted, ResourceUpdated

Agents

Types:

from julep.types import Agent

Methods:

• client.agents.create(**params) -> ResourceCreated
• client.agents.update(agent_id, **params) -> ResourceUpdated
• client.agents.list(**params) -> SyncOffsetPagination[Agent]
• client.agents.delete(agent_id) -> ResourceDeleted
• client.agents.create_or_update(agent_id, **params) -> ResourceCreated
• client.agents.get(agent_id) -> Agent
• client.agents.patch(agent_id, **params) -> ResourceUpdated

Tools

Types:

from julep.types.agents import ToolListResponse

Methods:

• client.agents.tools.create(agent_id, **params) -> ResourceCreated
• client.agents.tools.update(tool_id, *, agent_id, **params) -> ResourceUpdated
• client.agents.tools.list(agent_id, **params) -> SyncOffsetPagination[ToolListResponse]
• client.agents.tools.delete(tool_id, *, agent_id) -> ResourceDeleted
• client.agents.tools.patch(tool_id, *, agent_id, **params) -> ResourceUpdated

Docs

Types:

from julep.types.agents import DocSearchResponse

Methods:

• client.agents.docs.create(agent_id, **params) -> ResourceCreated
• client.agents.docs.list(agent_id, **params) -> SyncOffsetPagination[Doc]
• client.agents.docs.delete(doc_id, *, agent_id) -> ResourceDeleted
• client.agents.docs.search(agent_id, **params) -> DocSearchResponse

Files

Types:

from julep.types import File

Methods:

• client.files.create(**params) -> ResourceCreated
• client.files.delete(file_id) -> ResourceDeleted
• client.files.get(file_id) -> File

Sessions

Types:

from julep.types import (
    ChatInput,
    ChatResponse,
    ChatSettings,
    Entry,
    History,
    Message,
    Session,
    SessionChatResponse,
)

Methods:

• client.sessions.create(**params) -> ResourceCreated
• client.sessions.update(session_id, **params) -> ResourceUpdated
• client.sessions.list(**params) -> SyncOffsetPagination[Session]
• client.sessions.delete(session_id) -> ResourceDeleted
• client.sessions.chat(session_id, **params) -> SessionChatResponse
• client.sessions.create_or_update(session_id, **params) -> ResourceUpdated
• client.sessions.get(session_id) -> Session
• client.sessions.history(session_id) -> History
• client.sessions.patch(session_id, **params) -> ResourceUpdated

Users

Types:

from julep.types import User

Methods:

• client.users.create(**params) -> ResourceCreated
• client.users.update(user_id, **params) -> ResourceUpdated
• client.users.list(**params) -> SyncOffsetPagination[User]
• client.users.delete(user_id) -> ResourceDeleted
• client.users.create_or_update(user_id, **params) -> ResourceCreated
• client.users.get(user_id) -> User
• client.users.patch(user_id, **params) -> ResourceUpdated

Docs

Types:

from julep.types.users import DocSearchResponse

Methods:

• client.users.docs.create(user_id, **params) -> ResourceCreated
• client.users.docs.list(user_id, **params) -> SyncOffsetPagination[Doc]
• client.users.docs.delete(doc_id, *, user_id) -> ResourceDeleted
• client.users.docs.search(user_id, **params) -> DocSearchResponse

Jobs

Types:

from julep.types import JobStatus

Methods:

• client.jobs.get(job_id) -> JobStatus

Docs

Types:

from julep.types import Doc, EmbedQueryResponse, Snippet

Methods:

• client.docs.embed(**params) -> EmbedQueryResponse
• client.docs.get(doc_id) -> Doc

Tasks

Types:

from julep.types import Task

Methods:

• client.tasks.create(agent_id, **params) -> ResourceCreated
• client.tasks.list(agent_id, **params) -> SyncOffsetPagination[Task]
• client.tasks.create_or_update(task_id, *, agent_id, **params) -> ResourceUpdated
• client.tasks.get(task_id) -> Task

Executions

Types:

from julep.types import Execution, Transition, ExecutionChangeStatusResponse

Methods:

• client.executions.create(task_id, **params) -> ResourceCreated
• client.executions.list(task_id, **params) -> SyncOffsetPagination[Execution]
• client.executions.change_status(execution_id, **params) -> object
• client.executions.get(execution_id) -> Execution
• client.executions.patch(execution_id, *, task_id, **params) -> ResourceUpdated

Transitions

Types:

from julep.types.executions import TransitionStreamResponse

Methods:

• client.executions.transitions.list(execution_id, **params) -> SyncOffsetPagination[Transition]
• client.executions.transitions.stream(execution_id, **params) -> object