Julep Agents API
The Agents API from Julep — 13 operation(s) for agents.
Julep Agents API is one of 12 APIs that Julep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Agents. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.
This API exposes 28 operations across 13 paths, and defines 233 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.
28 operations
13 paths
233 schemas
6 DELETE7 GET3 PATCH8 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Julep Agents 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 28
Across 13 paths, the API surfaces 28 operations — 6 DELETE, 7 GET, 3 PATCH, 8 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Agents 28
GET
/agents
List Agents (paginated)
POST
/agents
Create a new Agent
GET
/agents/models
List all available models
POST
/agents/{id}
Create or update an Agent
PUT
/agents/{id}
Update an existing Agent by id (overwrites existing values; use PATCH for merging instead)
PATCH
/agents/{id}
Update an existing Agent by id (merges with existing values)
DELETE
/agents/{id}
Delete Agent by id
GET
/agents/{id}
Get an Agent by id
POST
/agents/{id}/docs
Create a Doc for this Agent
GET
/agents/{id}/docs
List Docs owned by an Agent
DELETE
/agents/{id}/docs
Bulk delete Docs owned by an Agent
DELETE
/agents/{id}/docs/{child_id}
Delete a Doc for this Agent
POST
/agents/{id}/search
Search Docs owned by an Agent
GET
/agents/{id}/secrets
List secrets (paginated)
POST
/agents/{id}/secrets
Create a new secret
PUT
/agents/{id}/secrets/{child_id}
Update an existing secret by id (overwrites existing values)
DELETE
/agents/{id}/secrets/{child_id}
Delete a secret by id
GET
/agents/{id}/tasks
List tasks (paginated)
POST
/agents/{id}/tasks
Create a new task
PUT
/agents/{id}/tasks/{child_id}
Update an existing task (overwrite existing values)
PATCH
/agents/{id}/tasks/{child_id}
Update an existing task (merges with existing values)
DELETE
/agents/{id}/tasks/{child_id}
Delete a task by its id
GET
/agents/{id}/tools
List tools of the given agent
POST
/agents/{id}/tools
Create a new resource owned by the given parent
PUT
/agents/{id}/tools/{child_id}
Update a resource owned by the given parent using its id
PATCH
/agents/{id}/tools/{child_id}
Patch a resource owned by the given parent using its id
DELETE
/agents/{id}/tools/{child_id}
Delete an existing tool by id
POST
/agents/{parent_id}/tasks/{id}
Create or update a task
Schemas 233
The contract defines 233 schemas that model the data the API accepts and returns. The most detailed are Tools.ApiCallDef (15 properties), Tools.ApiCallDefUpdate (15 properties), Tools.Tool (13 properties), Agents.Agent (12 properties). Each schema is shown below with its type and property counts.
Tools.UnstructuredIntegrationDefUpdate
object
Unstructured integration definition
4 properties
Tools.WeatherGetArgumentsUpdate
object
Arguments for Weather
1 property
Tools.BraveIntegrationDef
object
Brave integration definition
4 properties
1 required
Secrets.UpdateSecretRequest
object
4 properties
2 required
Common.uuid
string
Common.ResourceDeletedResponse
object
3 properties
3 required
Tools.LlamaParseFetchArgumentsUpdate
object
Arguments for LlamaParse integration
4 properties
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
Tasks.ReturnStep
object
2 properties
2 required
Common.stepLabel
string
A valid step label
Tools.McpListToolsArgumentsUpdate
object
Arguments to list available tools
1 property
Tools.RemoteBrowserSetup
object
The setup parameters for the remote browser
3 properties
Tools.DummyIntegrationDefUpdate
object
1 property
Tools.FfmpegIntegrationDefUpdate
object
Ffmpeg integration definition
4 properties
Agents.UpdateAgentRequest
object
Payload for updating a agent
9 properties
5 required
Tools.TextEditor20241022Def
object
2 properties
1 required
Tasks.CaseThen
object
2 properties
2 required
Tools.Bash20241022DefUpdate
object
2 properties
Common.PyExpression
string
A simple python expression compatible with SimpleEval.
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
Tasks.TaskTool
object
1 property
Tools.WikipediaSearchArgumentsUpdate
object
Arguments for Wikipedia Search
2 properties
Tasks.LogStep
object
2 properties
2 required
Tools.SecretRef
object
1 property
1 required
Tools.BrowserbaseExtensionArgumentsUpdate
object
2 properties
Tools.GoogleSheetsSetup
object
Setup parameters for Google Sheets integration
3 properties
1 required
Tools.BaseIntegrationDefUpdate
object
Integration definition
4 properties
Tools.CloudinaryEditIntegrationDefUpdate
object
Cloudinary edit integration definition
2 properties
Tasks.SwitchStepUpdateItem
object
1 property
1 required
Tasks.ToolCallStep
object
3 properties
3 required
Docs.Doc
object
10 properties
5 required
Tools.ChosenTextEditor20241022
object
7 properties
2 required
Tools.SpiderSetupUpdate
object
Setup parameters for Spider integration
1 property
Docs.Snippet
object
3 properties
2 required
Tools.AlgoliaSearchArguments
object
Arguments for Algolia Search
4 properties
2 required
Tasks.PromptStep
object
8 properties
5 required
Tools.AlgoliaSearchArgumentsUpdate
object
Arguments for Algolia Search
4 properties
Tools.BraveSearchSetup
object
Integration definition for Brave Search
1 property
1 required
Tools.CloudinaryUploadIntegrationDef
object
Cloudinary upload integration definition
2 properties
1 required
Tools.BrowserbaseGetSessionArgumentsUpdate
object
1 property
Tools.GoogleSheetsBatchWriteArgumentsUpdate
object
Arguments for batch updating values in multiple ranges
4 properties
Tools.BrowserbaseGetSessionIntegrationDef
object
browserbase get session integration definition
2 properties
1 required
Tools.MailgunSendEmailArgumentsUpdate
object
Arguments for mailgun.sendemail method
6 properties
Agents.PatchAgentRequest
object
Payload for patching a agent
9 properties
Docs.DocOwner
object
2 properties
2 required
Agents.Agent
object
12 properties
8 required
Tools.BrowserbaseCreateSessionIntegrationDefUpdate
object
browserbase create session integration definition
2 properties
Tasks.ForeachDoUpdateItem
object
2 properties
2 required
Tasks.ToolRefUpdateItem
object
Reference to a tool
Tools.WeatherIntegrationDefUpdate
object
Weather integration definition
4 properties
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
Tasks.WaitForInputInfo
object
1 property
1 required
Tools.BrowserbaseCompleteSessionIntegrationDef
object
browserbase complete session integration definition
2 properties
1 required
Tools.CloudinarySetupUpdate
object
Setup parameters for Cloudinary integration
4 properties
Tools.McpIntegrationDef
object
MCP integration definition
4 properties
1 required
Tools.LlamaParseIntegrationDefUpdate
object
LlamaParse integration definition
4 properties
Tools.WikipediaIntegrationDefUpdate
object
Wikipedia integration definition
4 properties
Tools.UnstructuredSetupUpdate
object
Setup parameters for Unstructured integration
6 properties
Tools.McpIntegrationDefUpdate
object
MCP integration definition
4 properties
Agents.ListModelsResponse
object
Response for the list models endpoint
1 property
1 required
Tools.BrowserbaseExtensionIntegrationDefUpdate
object
browserbase extension provider
2 properties
Tools.LlamaParseSetup
object
Setup parameters for LlamaParse integration
2 properties
1 required
Tools.McpSetupUpdate
object
Setup parameters for MCP integration
7 properties
Tools.WeatherIntegrationDef
object
Weather integration definition
4 properties
1 required
Tools.BrowserbaseGetSessionArguments
object
1 property
1 required
Tools.GoogleSheetsBatchReadArgumentsUpdate
object
Arguments for batch reading values from multiple ranges
5 properties
Tasks.Task
object
Object describing a Task
11 properties
9 required
Docs.VectorDocSearchRequest
object
6 properties
5 required
Tools.McpCallToolArgumentsUpdate
object
Arguments to call a named tool on the MCP server
3 properties
Entries.ImageDetail
string
Image detail level
Tools.BraveSearchSetupUpdate
object
Integration definition for Brave Search
1 property
Tools.CloudinaryUploadArgumentsUpdate
object
Arguments for Cloudinary media upload
4 properties
Tasks.WaitForInputStep
object
2 properties
2 required
Tools.UnstructuredPartitionArgumentsUpdate
object
Arguments for Unstructured partition integration
3 properties
Secrets.Secret
object
A secret that can be used in tasks and sessions
7 properties
5 required
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)
Tools.RemoteBrowserArguments
object
The arguments for the remote browser
4 properties
1 required
Tools.BrowserbaseListSessionsIntegrationDefUpdate
object
browserbase list sessions integration definition
2 properties
Tools.GoogleSheetsAppendArgumentsUpdate
object
Arguments for appending values to a spreadsheet
6 properties
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
Agents.CreateAgentRequest
object
Payload for creating a agent (and associated documents)
9 properties
5 required
Tools.UnstructuredPartitionArguments
object
Arguments for Unstructured partition integration
3 properties
1 required
Docs.CreateDocRequest
object
Payload for creating a doc
4 properties
3 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.RemoteBrowserArgumentsUpdate
object
The arguments for the remote browser
4 properties
Tools.ApiCallDefUpdate
object
API call definition
15 properties
Tools.BraveSearchArguments
object
Arguments for Brave Search
1 property
1 required
Tools.TextEditor20241022DefUpdate
object
2 properties
Tools.Computer20241022DefUpdate
object
Anthropic new tools
5 properties
Tools.McpListToolsArguments
object
Arguments to list available tools
1 property
1 required
Tools.Tool
object
13 properties
5 required
Tools.BrowserbaseSetupUpdate
object
The setup parameters for the browserbase integration
4 properties
Tools.EmailSetup
object
Setup parameters for Email integration
4 properties
4 required
Tools.WeatherSetup
object
Integration definition for Weather
1 property
1 required
Tools.BrowserbaseContextArgumentsUpdate
object
1 property
Tools.CloudinaryEditArgumentsUpdate
object
Arguments for Cloudinary media edit
3 properties
Tools.EmailIntegrationDef
object
Email integration definition
4 properties
1 required
Tools.EmailSetupUpdate
object
Setup parameters for Email integration
4 properties
Tools.BaseBrowserbaseIntegrationDefUpdate
object
The base definition for a browserbase integration
4 properties
Tools.GoogleSheetsIntegrationDefUpdate
object
Google Sheets integration definition
4 properties
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
Tools.BrowserbaseContextIntegrationDefUpdate
object
browserbase context provider
2 properties
Tools.MailgunSetupUpdate
object
Setup parameters for Mailgun integration
1 property
Tasks.ErrorWorkflowStep
object
2 properties
2 required
Tools.BraveSearchArgumentsUpdate
object
Arguments for Brave Search
1 property
Tasks.ForeachStep
object
2 properties
2 required
Tools.SpiderIntegrationDef
object
Spider integration definition
4 properties
1 required
Tools.ToolType
string
Tools.UpdateToolRequest
object
Payload for updating a tool
10 properties
2 required
Tools.BrowserbaseListSessionsIntegrationDef
object
browserbase list sessions integration definition
2 properties
1 required
Tools.ArxivIntegrationDefUpdate
object
Arxiv integration definition
4 properties
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
Tasks.EvaluateStep
object
2 properties
2 required
Docs.BulkDeleteDocsRequest
object
2 properties
2 required
Tools.AlgoliaIntegrationDefUpdate
object
Algolia integration definition
4 properties
Tasks.ToolRefByName
object
Reference to a tool by name
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
Tasks.CreateTaskRequest
object
Payload for creating a task
8 properties
6 required
Tools.ParameterSchema
object
JSON Schema for API call parameters
4 properties
2 required
Tools.BrowserbaseContextIntegrationDef
object
browserbase context provider
2 properties
Tools.CreateToolRequest
object
Payload for creating a tool
10 properties
2 required
Tools.FfmpegIntegrationDef
object
Ffmpeg integration definition
4 properties
1 required
Tools.ParameterSchemaUpdate
object
JSON Schema for API call parameters
4 properties
Tasks.YieldStep
object
3 properties
3 required
Tools.LlamaParseSetupUpdate
object
Setup parameters for LlamaParse integration
2 properties
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
Tools.SpiderFetchArgumentsUpdate
object
Arguments for Spider integration
3 properties
Tools.GoogleSheetsSetupUpdate
object
Setup parameters for Google Sheets integration
3 properties
Tools.BraveIntegrationDefUpdate
object
Brave integration definition
4 properties
Tasks.ToolRefById
object
Reference to a tool by id
1 property
Tools.Computer20241022Action
string
Tasks.ParallelStep
object
2 properties
2 required
Tools.BrowserbaseGetSessionIntegrationDefUpdate
object
browserbase get session integration definition
2 properties
Common.validPythonIdentifier
string
Valid python identifier names
Tools.GoogleSheetsClearArguments
object
Arguments for clearing values from a spreadsheet
2 properties
2 required
Tasks.SwitchStep
object
2 properties
2 required
Tools.LlamaParseIntegrationDef
object
LlamaParse integration definition
4 properties
1 required
Tools.GoogleSheetsWriteArgumentsUpdate
object
Arguments for writing values to a spreadsheet
6 properties
Tools.BrowserbaseCompleteSessionArgumentsUpdate
object
2 properties
Tools.WeatherSetupUpdate
object
Integration definition for Weather
1 property
Tools.FfmpegSearchArguments
object
Arguments for Ffmpeg CMD
2 properties
1 required
Tools.BrowserbaseGetSessionLiveUrlsArgumentsUpdate
object
1 property
Common.offset
integer
Offset to apply to the results
Tools.BrowserbaseCreateSessionIntegrationDef
object
browserbase create session integration definition
2 properties
1 required
Tools.PatchToolRequest
object
Payload for patching a tool
10 properties
Tasks.IfElseWorkflowStepUpdateItem
object
3 properties
3 required
Tasks.PatchTaskRequest
object
Payload for patching a task
8 properties
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.GoogleSheetsClearArgumentsUpdate
object
Arguments for clearing values from a spreadsheet
2 properties
Tasks.SleepStep
object
2 properties
2 required
Tools.SystemDefUpdate
object
System definition
5 properties
Tools.CloudinaryUploadIntegrationDefUpdate
object
Cloudinary upload integration definition
2 properties
Tools.BrowserbaseCompleteSessionIntegrationDefUpdate
object
browserbase complete session integration definition
2 properties
Tools.EmailIntegrationDefUpdate
object
Email integration definition
4 properties
Tools.BrowserbaseGetSessionLiveUrlsArguments
object
1 property
1 required
Tasks.CaseThenUpdateItem
object
2 properties
2 required
Tools.BrowserbaseExtensionIntegrationDef
object
browserbase extension provider
2 properties
Tools.BrowserbaseContextArguments
object
1 property
1 required
Tools.SpiderIntegrationDefUpdate
object
Spider integration definition
4 properties
Tools.BrowserbaseListSessionsArguments
object
1 property
Tools.BrowserbaseExtensionArguments
object
2 properties
1 required
Common.canonicalName
string
For canonical names (machine-friendly identifiers) Must start with a letter and can only contain letters, numbers, and underscores
Tools.PropertyDefinitionUpdate
object
Property definition for parameter schema
4 properties
Tools.FfmpegSearchArgumentsUpdate
object
Arguments for Ffmpeg CMD
2 properties
Tools.GoogleSheetsReadArgumentsUpdate
object
Arguments for reading values from a spreadsheet
5 properties
Tasks.ToolRef
object
Reference to a tool
1 property
1 required
Tools.MailgunIntegrationDefUpdate
object
Mailgun integration definition
4 properties
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
Tools.BrowserbaseGetSessionLiveUrlsIntegrationDefUpdate
object
browserbase get session live urls integration definition
2 properties
Tasks.ForeachStepUpdateItem
object
1 property
1 required
Tools.CloudinarySetup
object
Setup parameters for Cloudinary integration
4 properties
3 required
Tools.ArxivIntegrationDef
object
Arxiv integration definition
4 properties
1 required
Agents.ModelInfo
object
Model information returned by the model list endpoint
1 property
1 required
Tools.SecretRefUpdate
object
1 property
Tasks.ParallelStepUpdateItem
object
1 property
1 required
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
Common.displayName
string
For display names Must be between 1 and 255 characters
Tools.Computer20241022Def
object
Anthropic new tools
5 properties
3 required
Docs.TextOnlyDocSearchRequest
object
6 properties
6 required
Tools.BaseCloudinaryIntegrationDefUpdate
object
Base Cloudinary integration definition
3 properties
Tasks.UpdateTaskRequest
object
Payload for updating a task
8 properties
6 required
Tools.FunctionDef
object
Function definition
3 properties
Tools.BaseIntegrationDef
object
Integration definition
4 properties
1 required
Tasks.PromptStepUpdateItem
object
7 properties
4 required
Tools.MailgunIntegrationDef
object
Mailgun integration definition
4 properties
1 required
Common.content
string
Contents of a document
Tasks.IfElseWorkflowStep
object
4 properties
4 required
Tasks.ForeachDo
object
2 properties
2 required
Tasks.GetStep
object
2 properties
2 required
Docs.DocSearchResponse
object
2 properties
2 required
Tasks.SleepFor
object
4 properties
4 required
Tools.AlgoliaSetupUpdate
object
Integration definition for Algolia
2 properties
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
Secrets.CreateSecretRequest
object
4 properties
2 required
Tools.EmailArgumentsUpdate
object
Arguments for Email sending
4 properties
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.ArxivSearchArgumentsUpdate
object
Arguments for Arxiv Search
6 properties
Tools.RemoteBrowserIntegrationDefUpdate
object
The integration definition for the remote browser
4 properties
Tasks.SetStep
object
2 properties
2 required
Tools.GoogleSheetsBatchWriteArguments
object
Arguments for batch updating values in multiple ranges
4 properties
2 required
Common.JinjaTemplate
string
A valid jinja template.
Tools.BrowserbaseGetSessionLiveUrlsIntegrationDef
object
browserbase get session live urls integration definition
2 properties
1 required
Docs.HybridDocSearchRequest
object
11 properties
10 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Julep 11
Other APIs Julep publishes across the network.
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 Sessions API
Julep Tasks API
Julep Users API
#Agents