> ## Documentation Index
> Fetch the complete documentation index at: https://docs.julep.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Node.js SDK Reference

> Complete reference documentation for the Node.js SDK

# Shared

Types:

* <code><a href="./src/resources/shared.ts">ResourceCreated</a></code>
* <code><a href="./src/resources/shared.ts">ResourceDeleted</a></code>
* <code><a href="./src/resources/shared.ts">ResourceUpdated</a></code>

# Agents

Types:

* <code><a href="./src/resources/agents/agents.ts">Agent</a></code>

Methods:

* <code title="post /agents">client.agents.<a href="./src/resources/agents/agents.ts">create</a>(\{ ...params }) -> ResourceCreated</code>
* <code title="patch /agents/{agent_id}">client.agents.<a href="./src/resources/agents/agents.ts">update</a>(agentId, \{ ...params }) -> ResourceUpdated</code>
* <code title="get /agents">client.agents.<a href="./src/resources/agents/agents.ts">list</a>(\{ ...params }) -> AgentsOffsetPagination</code>
* <code title="delete /agents/{agent_id}">client.agents.<a href="./src/resources/agents/agents.ts">delete</a>(agentId) -> ResourceDeleted</code>
* <code title="post /agents/{agent_id}">client.agents.<a href="./src/resources/agents/agents.ts">createOrUpdate</a>(agentId, \{ ...params }) -> ResourceCreated</code>
* <code title="get /agents/{agent_id}">client.agents.<a href="./src/resources/agents/agents.ts">get</a>(agentId) -> Agent</code>
* <code title="put /agents/{agent_id}">client.agents.<a href="./src/resources/agents/agents.ts">reset</a>(agentId, \{ ...params }) -> ResourceUpdated</code>

## Tools

Types:

* <code><a href="./src/resources/agents/tools.ts">ToolListResponse</a></code>

Methods:

* <code title="post /agents/{agent_id}/tools">client.agents.tools.<a href="./src/resources/agents/tools.ts">create</a>(agentId, \{ ...params }) -> ResourceCreated</code>
* <code title="patch /agents/{agent_id}/tools/{tool_id}">client.agents.tools.<a href="./src/resources/agents/tools.ts">update</a>(agentId, toolId, \{ ...params }) -> ResourceUpdated</code>
* <code title="get /agents/{agent_id}/tools">client.agents.tools.<a href="./src/resources/agents/tools.ts">list</a>(agentId, \{ ...params }) -> ToolListResponsesOffsetPagination</code>
* <code title="delete /agents/{agent_id}/tools/{tool_id}">client.agents.tools.<a href="./src/resources/agents/tools.ts">delete</a>(agentId, toolId) -> ResourceDeleted</code>
* <code title="put /agents/{agent_id}/tools/{tool_id}">client.agents.tools.<a href="./src/resources/agents/tools.ts">reset</a>(agentId, toolId, \{ ...params }) -> ResourceUpdated</code>

## Docs

Types:

* <code><a href="./src/resources/agents/docs.ts">DocSearchResponse</a></code>

Methods:

* <code title="post /agents/{agent_id}/docs">client.agents.docs.<a href="./src/resources/agents/docs.ts">create</a>(agentId, \{ ...params }) -> ResourceCreated</code>
* <code title="get /agents/{agent_id}/docs">client.agents.docs.<a href="./src/resources/agents/docs.ts">list</a>(agentId, \{ ...params }) -> DocsOffsetPagination</code>
* <code title="delete /agents/{agent_id}/docs/{doc_id}">client.agents.docs.<a href="./src/resources/agents/docs.ts">delete</a>(agentId, docId) -> ResourceDeleted</code>
* <code title="post /agents/{agent_id}/search">client.agents.docs.<a href="./src/resources/agents/docs.ts">search</a>(agentId, \{ ...params }) -> DocSearchResponse</code>

# Files

Types:

* <code><a href="./src/resources/files.ts">File</a></code>

Methods:

* <code title="post /files">client.files.<a href="./src/resources/files.ts">create</a>(\{ ...params }) -> ResourceCreated</code>
* <code title="delete /files/{file_id}">client.files.<a href="./src/resources/files.ts">delete</a>(fileId) -> ResourceDeleted</code>
* <code title="get /files/{file_id}">client.files.<a href="./src/resources/files.ts">get</a>(fileId) -> File</code>

# Sessions

Types:

* <code><a href="./src/resources/sessions.ts">ChatInput</a></code>
* <code><a href="./src/resources/sessions.ts">ChatResponse</a></code>
* <code><a href="./src/resources/sessions.ts">ChatSettings</a></code>
* <code><a href="./src/resources/sessions.ts">Entry</a></code>
* <code><a href="./src/resources/sessions.ts">History</a></code>
* <code><a href="./src/resources/sessions.ts">Message</a></code>
* <code><a href="./src/resources/sessions.ts">Session</a></code>
* <code><a href="./src/resources/sessions.ts">SessionChatResponse</a></code>

Methods:

* <code title="post /sessions">client.sessions.<a href="./src/resources/sessions.ts">create</a>(\{ ...params }) -> ResourceCreated</code>
* <code title="patch /sessions/{session_id}">client.sessions.<a href="./src/resources/sessions.ts">update</a>(sessionId, \{ ...params }) -> ResourceUpdated</code>
* <code title="get /sessions">client.sessions.<a href="./src/resources/sessions.ts">list</a>(\{ ...params }) -> SessionsOffsetPagination</code>
* <code title="delete /sessions/{session_id}">client.sessions.<a href="./src/resources/sessions.ts">delete</a>(sessionId) -> ResourceDeleted</code>
* <code title="post /sessions/{session_id}/chat">client.sessions.<a href="./src/resources/sessions.ts">chat</a>(sessionId, \{ ...params }) -> SessionChatResponse</code>
* <code title="post /sessions/{session_id}">client.sessions.<a href="./src/resources/sessions.ts">createOrUpdate</a>(sessionId, \{ ...params }) -> ResourceUpdated</code>
* <code title="get /sessions/{session_id}">client.sessions.<a href="./src/resources/sessions.ts">get</a>(sessionId) -> Session</code>
* <code title="get /sessions/{session_id}/history">client.sessions.<a href="./src/resources/sessions.ts">history</a>(sessionId) -> History</code>
* <code title="put /sessions/{session_id}">client.sessions.<a href="./src/resources/sessions.ts">reset</a>(sessionId, \{ ...params }) -> ResourceUpdated</code>

# Users

Types:

* <code><a href="./src/resources/users/users.ts">User</a></code>

Methods:

* <code title="post /users">client.users.<a href="./src/resources/users/users.ts">create</a>(\{ ...params }) -> ResourceCreated</code>
* <code title="patch /users/{user_id}">client.users.<a href="./src/resources/users/users.ts">update</a>(userId, \{ ...params }) -> ResourceUpdated</code>
* <code title="get /users">client.users.<a href="./src/resources/users/users.ts">list</a>(\{ ...params }) -> UsersOffsetPagination</code>
* <code title="delete /users/{user_id}">client.users.<a href="./src/resources/users/users.ts">delete</a>(userId) -> ResourceDeleted</code>
* <code title="post /users/{user_id}">client.users.<a href="./src/resources/users/users.ts">createOrUpdate</a>(userId, \{ ...params }) -> ResourceCreated</code>
* <code title="get /users/{user_id}">client.users.<a href="./src/resources/users/users.ts">get</a>(userId) -> User</code>
* <code title="put /users/{user_id}">client.users.<a href="./src/resources/users/users.ts">reset</a>(userId, \{ ...params }) -> ResourceUpdated</code>

## Docs

Types:

* <code><a href="./src/resources/users/docs.ts">DocSearchResponse</a></code>

Methods:

* <code title="post /users/{user_id}/docs">client.users.docs.<a href="./src/resources/users/docs.ts">create</a>(userId, \{ ...params }) -> ResourceCreated</code>
* <code title="get /users/{user_id}/docs">client.users.docs.<a href="./src/resources/users/docs.ts">list</a>(userId, \{ ...params }) -> DocsOffsetPagination</code>
* <code title="delete /users/{user_id}/docs/{doc_id}">client.users.docs.<a href="./src/resources/users/docs.ts">delete</a>(userId, docId) -> ResourceDeleted</code>
* <code title="post /users/{user_id}/search">client.users.docs.<a href="./src/resources/users/docs.ts">search</a>(userId, \{ ...params }) -> DocSearchResponse</code>

# Jobs

Types:

* <code><a href="./src/resources/jobs.ts">JobStatus</a></code>

Methods:

* <code title="get /jobs/{job_id}">client.jobs.<a href="./src/resources/jobs.ts">get</a>(jobId) -> JobStatus</code>

# Docs

Types:

* <code><a href="./src/resources/docs.ts">Doc</a></code>
* <code><a href="./src/resources/docs.ts">EmbedQueryResponse</a></code>
* <code><a href="./src/resources/docs.ts">Snippet</a></code>

Methods:

* <code title="post /embed">client.docs.<a href="./src/resources/docs.ts">embed</a>(\{ ...params }) -> EmbedQueryResponse</code>
* <code title="get /docs/{doc_id}">client.docs.<a href="./src/resources/docs.ts">get</a>(docId) -> Doc</code>

# Tasks

Types:

* <code><a href="./src/resources/tasks.ts">Task</a></code>

Methods:

* <code title="post /agents/{agent_id}/tasks">client.tasks.<a href="./src/resources/tasks.ts">create</a>(agentId, \{ ...params }) -> ResourceCreated</code>
* <code title="get /agents/{agent_id}/tasks">client.tasks.<a href="./src/resources/tasks.ts">list</a>(agentId, \{ ...params }) -> TasksOffsetPagination</code>
* <code title="post /agents/{agent_id}/tasks/{task_id}">client.tasks.<a href="./src/resources/tasks.ts">createOrUpdate</a>(agentId, taskId, \{ ...params }) -> ResourceUpdated</code>
* <code title="get /tasks/{task_id}">client.tasks.<a href="./src/resources/tasks.ts">get</a>(taskId) -> Task</code>

# Executions

Types:

* <code><a href="./src/resources/executions/executions.ts">Execution</a></code>
* <code><a href="./src/resources/executions/executions.ts">Transition</a></code>
* <code><a href="./src/resources/executions/executions.ts">ExecutionChangeStatusResponse</a></code>

Methods:

* <code title="post /tasks/{task_id}/executions">client.executions.<a href="./src/resources/executions/executions.ts">create</a>(taskId, \{ ...params }) -> ResourceCreated</code>
* <code title="get /tasks/{task_id}/executions">client.executions.<a href="./src/resources/executions/executions.ts">list</a>(taskId, \{ ...params }) -> ExecutionsOffsetPagination</code>
* <code title="put /executions/{execution_id}">client.executions.<a href="./src/resources/executions/executions.ts">changeStatus</a>(executionId, \{ ...params }) -> unknown</code>
* <code title="get /executions/{execution_id}">client.executions.<a href="./src/resources/executions/executions.ts">get</a>(executionId) -> Execution</code>

## Transitions

Types:

* <code><a href="./src/resources/executions/transitions.ts">TransitionStreamResponse</a></code>

Methods:

* <code title="get /executions/{execution_id}/transitions">client.executions.transitions.<a href="./src/resources/executions/transitions.ts">list</a>(executionId, \{ ...params }) -> TransitionsOffsetPagination</code>
* <code title="get /executions/{execution_id}/transitions.stream">client.executions.transitions.<a href="./src/resources/executions/transitions.ts">stream</a>(executionId, \{ ...params }) -> unknown</code> \*/} \*/}
