api.md

Shared Types

from julep.types import (
    AlgoliaIntegrationDef,
    AlgoliaSearchArguments,
    AlgoliaSetup,
    ArxivIntegrationDef,
    ArxivSearchArguments,
    Bash20241022Def,
    BraveIntegrationDef,
    BraveSearchArguments,
    BraveSearchSetup,
    BrowserbaseCompleteSessionArguments,
    BrowserbaseCompleteSessionIntegrationDef,
    BrowserbaseContextArguments,
    BrowserbaseContextIntegrationDef,
    BrowserbaseCreateSessionArguments,
    BrowserbaseCreateSessionIntegrationDef,
    BrowserbaseExtensionArguments,
    BrowserbaseExtensionIntegrationDef,
    BrowserbaseGetSessionArguments,
    BrowserbaseGetSessionIntegrationDef,
    BrowserbaseGetSessionLiveURLsArguments,
    BrowserbaseGetSessionLiveURLsIntegrationDef,
    BrowserbaseListSessionsArguments,
    BrowserbaseListSessionsIntegrationDef,
    BrowserbaseSetup,
    CloudinaryEditArguments,
    CloudinaryEditIntegrationDef,
    CloudinarySetup,
    CloudinaryUploadArguments,
    CloudinaryUploadIntegrationDef,
    Computer20241022Def,
    DocOwner,
    DocReference,
    DummyIntegrationDef,
    EmailArguments,
    EmailIntegrationDef,
    EmailSetup,
    FfmpegIntegrationDef,
    FfmpegSearchArguments,
    FunctionCallOption,
    FunctionDef,
    IfElseStepInput,
    IfElseStepOutput,
    LlamaParseFetchArguments,
    LlamaParseIntegrationDef,
    LlamaParseSetup,
    MailgunIntegrationDef,
    MailgunSendEmailArguments,
    MailgunSetup,
    NamedToolChoice,
    PromptStepInput,
    RemoteBrowserArguments,
    RemoteBrowserIntegrationDef,
    RemoteBrowserSetup,
    SecretRef,
    SpiderFetchArguments,
    SpiderIntegrationDef,
    SpiderSetup,
    SystemDef,
    TextEditor20241022Def,
    UnstructuredIntegrationDef,
    UnstructuredPartitionArguments,
    UnstructuredSetup,
    WeatherGetArguments,
    WeatherIntegrationDef,
    WeatherSetup,
    WikipediaIntegrationDef,
    WikipediaSearchArguments,
)

Agents

Types:

from julep.types import Agent, AgentDeleteResponse, AgentListModelsResponse

Methods:

• client.agents.create(**params) -> Agent
• client.agents.update(agent_id, **params) -> Agent
• client.agents.list(**params) -> SyncOffsetPagination[Agent]
• client.agents.delete(agent_id) -> AgentDeleteResponse
• client.agents.create_or_update(agent_id, **params) -> Agent
• client.agents.get(agent_id) -> Agent
• client.agents.list_models() -> AgentListModelsResponse
• client.agents.reset(agent_id, **params) -> Agent

Tools

Types:

from julep.types.agents import (
    BrowserbaseSetupUpdate,
    ToolCreateResponse,
    ToolUpdateResponse,
    ToolListResponse,
    ToolDeleteResponse,
    ToolResetResponse,
)

Methods:

• client.agents.tools.create(agent_id, **params) -> ToolCreateResponse
• client.agents.tools.update(tool_id, *, agent_id, **params) -> ToolUpdateResponse
• client.agents.tools.list(agent_id, **params) -> SyncOffsetPagination[ToolListResponse]
• client.agents.tools.delete(tool_id, *, agent_id) -> ToolDeleteResponse
• client.agents.tools.reset(tool_id, *, agent_id, **params) -> ToolResetResponse

Docs

Types:

from julep.types.agents import DocDeleteResponse, DocBulkDeleteResponse, DocSearchResponse

Methods:

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

Files

Types:

from julep.types import File, FileListResponse, FileDeleteResponse

Methods:

• client.files.create(**params) -> File
• client.files.list() -> FileListResponse
• client.files.delete(file_id) -> FileDeleteResponse
• client.files.get(file_id) -> File

Sessions

Types:

from julep.types import (
    BaseTokenLogProb,
    ChatInput,
    ChatResponse,
    ChosenBash20241022,
    ChosenComputer20241022,
    ChosenFunctionCall,
    ChosenTextEditor20241022,
    Entry,
    History,
    HybridDocSearch,
    LogProbResponse,
    SchemaCompletionResponseFormat,
    Session,
    SimpleCompletionResponseFormat,
    TextOnlyDocSearch,
    TokenLogProb,
    VectorDocSearch,
    SessionDeleteResponse,
    SessionChatResponse,
    SessionRenderResponse,
)

Methods:

• client.sessions.create(**params) -> Session
• client.sessions.update(session_id, **params) -> Session
• client.sessions.list(**params) -> SyncOffsetPagination[Session]
• client.sessions.delete(session_id) -> SessionDeleteResponse
• client.sessions.chat(session_id, **params) -> SessionChatResponse
• client.sessions.create_or_update(session_id, **params) -> Session
• client.sessions.get(session_id) -> Session
• client.sessions.history(session_id) -> History
• client.sessions.render(session_id, **params) -> SessionRenderResponse
• client.sessions.reset(session_id, **params) -> Session

Users

Types:

from julep.types import User, UserDeleteResponse

Methods:

• client.users.create(**params) -> User
• client.users.update(user_id, **params) -> User
• client.users.list(**params) -> SyncOffsetPagination[User]
• client.users.delete(user_id) -> UserDeleteResponse
• client.users.create_or_update(user_id, **params) -> User
• client.users.get(user_id) -> User
• client.users.reset(user_id, **params) -> User

Docs

Types:

from julep.types.users import DocDeleteResponse, DocBulkDeleteResponse, DocSearchResponse

Methods:

• client.users.docs.create(user_id, **params) -> Doc
• client.users.docs.list(user_id, **params) -> SyncOffsetPagination[Doc]
• client.users.docs.delete(doc_id, *, user_id) -> DocDeleteResponse
• client.users.docs.bulk_delete(user_id, **params) -> DocBulkDeleteResponse
• 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, **params) -> Doc

Tasks

Types:

from julep.types import (
    CaseThenOutput,
    ErrorWorkflowStep,
    EvaluateStep,
    ForeachDoOutput,
    ForeachStepOutput,
    GetStep,
    LogStep,
    ParallelStepOutput,
    PromptStepOutput,
    ReturnStep,
    SetStep,
    SleepFor,
    SleepStep,
    SwitchStepOutput,
    Task,
    ToolCallStep,
    WaitForInputInfo,
    WaitForInputStep,
    YieldStep,
)

Methods:

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

Executions

Types:

from julep.types import Execution, Transition

Methods:

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

Transitions

Methods:

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

Status

Methods:

• client.executions.status.get(execution_id) -> Execution
• client.executions.status.stream(execution_id) -> None

Secrets

Types:

from julep.types import Secret, SecretListResponse, SecretDeleteResponse

Methods:

• client.secrets.create(**params) -> Secret
• client.secrets.update(secret_id, **params) -> Secret
• client.secrets.list(**params) -> SecretListResponse
• client.secrets.delete(secret_id) -> SecretDeleteResponse

Projects

Types:

from julep.types import ProjectCreateResponse, ProjectListResponse

Methods:

• client.projects.create(**params) -> ProjectCreateResponse
• client.projects.list(**params) -> SyncOffsetPagination[ProjectListResponse]

Healthz

Methods:

• client.healthz.check() -> object