Julep Sessions API
The Sessions API from Julep — 5 operation(s) for sessions.
Julep Sessions API is one of 12 APIs that Julep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sessions. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 11 operations across 5 paths, and defines 137 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.
Requests are made against a single base URL, https://{serverEnv}.julep.ai/api.
11 operations
5 paths
137 schemas
2 DELETE3 GET1 PATCH4 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Julep Sessions API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (ApiKeyAuth).
An API key is passed in the header as X-Auth-Key (ApiKeyAuth_).
By default, every request must be authenticated.
Paths & Operations 11
Across 5 paths, the API surfaces 11 operations — 2 DELETE, 3 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Sessions 11
GET
/sessions
List sessions (paginated)
POST
/sessions
Create a new session
POST
/sessions/{id}
Create or update a session
PUT
/sessions/{id}
Update an existing session by its id (overwrites all existing values)
PATCH
/sessions/{id}
Update an existing session by its id (merges with existing values)
DELETE
/sessions/{id}
Delete a session by its id
GET
/sessions/{id}
Get a session by id
POST
/sessions/{id}/chat
Generate a response from the model
DELETE
/sessions/{id}/history
Clear the history of a Session (resets the Session)
GET
/sessions/{id}/history
Get history of a Session
POST
/sessions/{id}/render
Render system prompt for the session
Schemas 137
The contract defines 137 schemas that model the data the API accepts and returns. The most detailed are Chat.ChatInput (21 properties), Tools.ApiCallDef (15 properties), Sessions.Session (14 properties), Tools.Tool (13 properties). Each schema is shown below with its type and property counts.
Tools.BraveIntegrationDef
object
Brave integration definition
4 properties
1 required
Common.uuid
string
Common.ResourceDeletedResponse
object
3 properties
3 required
Tools.FunctionCallOption
object
2 properties
1 required
Tools.GoogleSheetsBatchReadArguments
object
Arguments for batch reading values from multiple ranges
5 properties
2 required
Tools.WikipediaIntegrationDef
object
Wikipedia integration definition
4 properties
1 required
Tools.WikipediaSearchArguments
object
Arguments for Wikipedia Search
2 properties
2 required
Chat.ChatInput
object
21 properties
7 required
Tools.RemoteBrowserSetup
object
The setup parameters for the remote browser
3 properties
Sessions.VectorDocSearch
object
3 properties
2 required
Tools.TextEditor20241022Def
object
2 properties
1 required
Tools.McpSetup
object
Setup parameters for MCP integration
7 properties
1 required
Tools.BrowserbaseCreateSessionArguments
object
6 properties
Tools.McpCallToolArguments
object
Arguments to call a named tool on the MCP server
3 properties
1 required
Tools.SecretRef
object
1 property
1 required
Sessions.ContextOverflowType
string
Tools.GoogleSheetsSetup
object
Setup parameters for Google Sheets integration
3 properties
1 required
Chat.CompletionUsage
object
Usage statistics for the completion request
3 properties
Entries.Entry
object
2 properties
2 required
Tools.ChosenTextEditor20241022
object
7 properties
2 required
Docs.Snippet
object
3 properties
2 required
Tools.AlgoliaSearchArguments
object
Arguments for Algolia Search
4 properties
2 required
Chat.ChunkChatResponse
object
1 property
1 required
Chat.LogProbResponse
object
1 property
1 required
Tools.BraveSearchSetup
object
Integration definition for Brave Search
1 property
1 required
Tools.CloudinaryUploadIntegrationDef
object
Cloudinary upload integration definition
2 properties
1 required
Tools.BrowserbaseGetSessionIntegrationDef
object
browserbase get session integration definition
2 properties
1 required
Chat.ChatOutputChunk
object
Streaming chat completion output
1 property
1 required
Tools.ToolResponse
object
2 properties
2 required
Docs.DocOwner
object
2 properties
2 required
Sessions.CreateSessionRequest
object
Payload for creating a session
13 properties
6 required
Tools.RemoteBrowserIntegrationDef
object
The integration definition for the remote browser
4 properties
3 required
Tools.ChosenBash20241022
object
2 properties
Tools.AlgoliaSetup
object
Integration definition for Algolia
2 properties
2 required
Tools.BrowserbaseCompleteSessionIntegrationDef
object
browserbase complete session integration definition
2 properties
1 required
Tools.McpIntegrationDef
object
MCP integration definition
4 properties
1 required
Chat.BaseTokenLogProb
object
3 properties
2 required
Tools.LlamaParseSetup
object
Setup parameters for LlamaParse integration
2 properties
1 required
Tools.WeatherIntegrationDef
object
Weather integration definition
4 properties
1 required
Tools.BrowserbaseGetSessionArguments
object
1 property
1 required
Entries.ImageDetail
string
Image detail level
Tools.AlgoliaIntegrationDef
object
Algolia integration definition
4 properties
1 required
Tools.PropertyDefinition
object
Property definition for parameter schema
4 properties
1 required
Entries.ChatMLRole
string
ChatML role (system|assistant|user|tool)
Sessions.HybridDocSearch
object
6 properties
4 required
Tools.RemoteBrowserArguments
object
The arguments for the remote browser
4 properties
1 required
Entries.Relation
object
3 properties
3 required
Tools.ArxivSearchArguments
object
Arguments for Arxiv Search
6 properties
1 required
Common.limit
integer
Limit the number of results
Tools.BaseBrowserbaseIntegrationDef
object
The base definition for a browserbase integration
4 properties
1 required
Tools.UnstructuredPartitionArguments
object
Arguments for Unstructured partition integration
3 properties
1 required
Tools.DummyIntegrationDef
object
1 property
1 required
Tools.CloudinaryEditArguments
object
Arguments for Cloudinary media edit
3 properties
3 required
Tools.WeatherGetArguments
object
Arguments for Weather
1 property
1 required
Tools.BraveSearchArguments
object
Arguments for Brave Search
1 property
1 required
Tools.McpListToolsArguments
object
Arguments to list available tools
1 property
1 required
Chat.SimpleCompletionResponseFormat
object
1 property
1 required
Tools.Tool
object
13 properties
5 required
Tools.EmailSetup
object
Setup parameters for Email integration
4 properties
4 required
Tools.WeatherSetup
object
Integration definition for Weather
1 property
1 required
Tools.EmailIntegrationDef
object
Email integration definition
4 properties
1 required
Chat.SchemaCompletionResponseFormat
object
2 properties
2 required
Tools.GoogleSheetsAppendArguments
object
Arguments for appending values to a spreadsheet
6 properties
3 required
Tools.SpiderSetup
object
Setup parameters for Spider integration
1 property
1 required
Tools.BrowserbaseCompleteSessionArguments
object
2 properties
1 required
Entries.History
object
4 properties
4 required
Entries.BaseEntry
object
10 properties
8 required
Sessions.Session
object
14 properties
10 required
Sessions.HybridDocSearchUpdate
object
6 properties
Sessions.TextOnlyDocSearch
object
2 properties
1 required
Tools.SpiderIntegrationDef
object
Spider integration definition
4 properties
1 required
Tools.ToolType
string
Tools.BrowserbaseListSessionsIntegrationDef
object
browserbase list sessions integration definition
2 properties
1 required
Tools.ChosenComputer20241022
object
3 properties
1 required
Docs.DocReference
object
6 properties
4 required
Tools.BrowserbaseSetup
object
The setup parameters for the browserbase integration
4 properties
2 required
Tools.NamedToolChoice
object
1 property
Tools.LlamaParseFetchArguments
object
Arguments for LlamaParse integration
4 properties
1 required
Tools.SystemDef
object
System definition
5 properties
2 required
Tools.GoogleSheetsValueRange
object
Represents a range of values to write
3 properties
2 required
Tools.ParameterSchema
object
JSON Schema for API call parameters
4 properties
2 required
Tools.BrowserbaseContextIntegrationDef
object
browserbase context provider
2 properties
Chat.TokenLogProb
object
1 property
1 required
Tools.CreateToolRequest
object
Payload for creating a tool
10 properties
2 required
Tools.FfmpegIntegrationDef
object
Ffmpeg integration definition
4 properties
1 required
Tools.UnstructuredSetup
object
Setup parameters for Unstructured integration
6 properties
1 required
Tools.GoogleSheetsWriteArguments
object
Arguments for writing values to a spreadsheet
6 properties
3 required
Chat.ChatInputData
object
3 properties
2 required
Tools.Computer20241022Action
string
Common.validPythonIdentifier
string
Valid python identifier names
Sessions.TextOnlyDocSearchUpdate
object
2 properties
Tools.GoogleSheetsClearArguments
object
Arguments for clearing values from a spreadsheet
2 properties
2 required
Tools.LlamaParseIntegrationDef
object
LlamaParse integration definition
4 properties
1 required
Tools.FfmpegSearchArguments
object
Arguments for Ffmpeg CMD
2 properties
1 required
Common.offset
integer
Offset to apply to the results
Tools.BrowserbaseCreateSessionIntegrationDef
object
browserbase create session integration definition
2 properties
1 required
Sessions.BaseDocSearch
object
6 properties
6 required
Tools.EmailArguments
object
Arguments for Email sending
4 properties
4 required
Tools.BaseChosenToolCall
object
The response tool value generated by the model
9 properties
1 required
Tools.BrowserbaseGetSessionLiveUrlsArguments
object
1 property
1 required
Tools.BrowserbaseExtensionIntegrationDef
object
browserbase extension provider
2 properties
Tools.BrowserbaseContextArguments
object
1 property
1 required
Chat.BaseChatOutput
object
4 properties
2 required
Tools.BrowserbaseListSessionsArguments
object
1 property
Tools.BrowserbaseExtensionArguments
object
2 properties
1 required
Chat.SingleChatOutput
object
The output returned by the model. Note that, depending on the model provider, they might return more than one message.
1 property
1 required
Tools.ApiCallDef
object
API call definition
15 properties
2 required
Tools.GoogleSheetsIntegrationDef
object
Google Sheets integration definition
4 properties
1 required
Tools.CloudinaryUploadArguments
object
Arguments for Cloudinary media upload
4 properties
2 required
Tools.Bash20241022Def
object
2 properties
1 required
Chat.FinishReason
string
The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence, length if the maximum numb…
Sessions.UpdateSessionRequest
object
Payload for updating a session
9 properties
6 required
Tools.CloudinarySetup
object
Setup parameters for Cloudinary integration
4 properties
3 required
Tools.ArxivIntegrationDef
object
Arxiv integration definition
4 properties
1 required
Chat.MultipleChatOutput
object
The output returned by the model. Note that, depending on the model provider, they might return more than one message.
1 property
1 required
Sessions.BaseDocSearchUpdate
object
6 properties
Tools.SpiderFetchArguments
object
Arguments for Spider integration
3 properties
1 required
Tools.BaseCloudinaryIntegrationDef
object
Base Cloudinary integration definition
3 properties
1 required
Tools.UnstructuredIntegrationDef
object
Unstructured integration definition
4 properties
1 required
Chat.RenderResponse
object
1 property
1 required
Tools.Computer20241022Def
object
Anthropic new tools
5 properties
3 required
Sessions.PatchSessionRequest
object
Payload for patching a session
9 properties
Tools.FunctionDef
object
Function definition
3 properties
Chat.MessageChatResponse
object
1 property
1 required
Tools.BaseIntegrationDef
object
Integration definition
4 properties
1 required
Tools.MailgunIntegrationDef
object
Mailgun integration definition
4 properties
1 required
Common.identifierSafeUnicode
string
For Unicode character safety See: https://unicode.org/reports/tr31/ See: https://www.unicode.org/reports/tr39/IdentifierCharacters
Tools.GoogleSheetsReadArguments
object
Arguments for reading values from a spreadsheet
5 properties
2 required
Tools.MailgunSetup
object
Setup parameters for Mailgun integration
1 property
1 required
Sessions.VectorDocSearchUpdate
object
3 properties
Common.logit_bias
number
Chat.BaseChatResponse
object
5 properties
4 required
Tools.ChosenFunctionCall
object
2 properties
2 required
Tools.CloudinaryEditIntegrationDef
object
Cloudinary edit integration definition
2 properties
1 required
Tools.MailgunSendEmailArguments
object
Arguments for mailgun.sendemail method
6 properties
4 required
Tools.GoogleSheetsBatchWriteArguments
object
Arguments for batch updating values in multiple ranges
4 properties
2 required
Tools.BrowserbaseGetSessionLiveUrlsIntegrationDef
object
browserbase get session live urls integration definition
2 properties
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Julep 11
Other APIs Julep publishes across the network.
Julep Agents API
Julep Docs API
Julep Embed API
Julep Executions API
Julep Files API
Julep Jobs API
Julep Projects API
Julep Responses API
Julep Secrets API
Julep Tasks API
Julep Users API
#Sessions