Agents

API for creating and modifying Agents

List agents

List agents created (use limit/offset pagination to get large number of sessions; sorted by descending order of created_at by default)

GEThttps://api-alpha.julep.ai/api/agents

Authorization

Query parameters

Response

List of agents (sorted created_at descending order) with limit+offset pagination

Body

items*array of Agent (object)

Request

const response = await fetch('https://api-alpha.julep.ai/api/agents', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "name": "text",
      "about": "text",
      "instructions": [
        "text"
      ],
      "created_at": "2024-05-19T09:30:57.446Z",
      "updated_at": "2024-05-19T09:30:57.446Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "default_settings": {
        "frequency_penalty": 0,
        "length_penalty": 1,
        "presence_penalty": 0,
        "repetition_penalty": 1,
        "temperature": 0.75,
        "top_p": 1,
        "min_p": 0.01,
        "preset": "problem_solving"
      },
      "model": "julep-ai/samantha-1-turbo",
      "metadata": {}
    }
  ]
}

Create a new agent

POSThttps://api-alpha.julep.ai/api/agents

Authorization

Body

Agent create options

name*string

Name of the agent

aboutstring

About the agent

instructionsarray of string

List of instructions for the agent

toolsarray of CreateToolRequest (object)

A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.

default_settingsAgentDefaultSettings (object)

modelstring

Name of the model that the agent is supposed to use

docsarray of CreateDoc (object)

List of docs about agent

metadataobject

(Optional) metadata

Response

Agent successfully created

Body

id*string (uuid)

created_at*string (date-time)

jobsarray of string (uuid)

IDs (if any) of jobs created as part of this request

Request

const response = await fetch('https://api-alpha.julep.ai/api/agents', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-05-19T09:30:57.446Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Get a specific agent by id

Get details of the agent

GEThttps://api-alpha.julep.ai/api/agents/{agent_id}

Authorization

Path parameters

agent_id*string (uuid)

Response

Body

name*string

Name of the agent

aboutstring

About the agent

instructionsarray of string

List of instructions for the agent

created_atstring (date-time)

Agent created at (RFC-3339 format)

updated_atstring (date-time)

Agent updated at (RFC-3339 format)

id*string (uuid)

Agent id (UUID)

default_settingsAgentDefaultSettings (object)

model*string

The model to use with this agent

metadataobject

Optional metadata

Request

const response = await fetch('https://api-alpha.julep.ai/api/agents/{agent_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "name": "text",
  "about": "text",
  "instructions": [
    "text"
  ],
  "created_at": "2024-05-19T09:30:57.446Z",
  "updated_at": "2024-05-19T09:30:57.446Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "default_settings": {
    "frequency_penalty": 0,
    "length_penalty": 1,
    "presence_penalty": 0,
    "repetition_penalty": 1,
    "temperature": 0.75,
    "top_p": 1,
    "min_p": 0.01,
    "preset": "problem_solving"
  },
  "model": "julep-ai/samantha-1-turbo",
  "metadata": {}
}

Update an agent

Update agent parameters

PUThttps://api-alpha.julep.ai/api/agents/{agent_id}

Authorization

Path parameters

agent_id*string (uuid)

Body

about*string

About the agent

instructionsarray of string

List of instructions for the agent

name*string

Name of the agent

modelstring

Name of the model that the agent is supposed to use

default_settingsAgentDefaultSettings (object)

metadataobject

Optional metadata

Response

Body

id*string (uuid)

updated_at*string (date-time)

jobsarray of string (uuid)

IDs (if any) of jobs created as part of this request

Request

const response = await fetch('https://api-alpha.julep.ai/api/agents/{agent_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "about": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2024-05-19T09:30:57.446Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Delete an agent

Delete agent

DELETEhttps://api-alpha.julep.ai/api/agents/{agent_id}

Authorization

Path parameters

agent_id*string (uuid)

Response

Body

id*string (uuid)

deleted_at*string (date-time)

jobsarray of string (uuid)

IDs (if any) of jobs created as part of this request

Request

const response = await fetch('https://api-alpha.julep.ai/api/agents/{agent_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deleted_at": "2024-05-19T09:30:57.446Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

List all tools

Get tools of the agent

Sorted (created_at descending)

GEThttps://api-alpha.julep.ai/api/agents/{agent_id}/tools

Authorization

Path parameters

agent_id*string (uuid)

Query parameters

Body

Response

Body

itemsarray of Tool (object)

Request

const response = await fetch('https://api-alpha.julep.ai/api/agents/{agent_id}/tools', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "type": "function",
      "function": {
        "description": "text",
        "name": "text",
        "parameters": {}
      },
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Create a new tool for agent

Create tool for the agent

POSThttps://api-alpha.julep.ai/api/agents/{agent_id}/tools

Authorization

Path parameters

agent_id*string (uuid)

Body

type*enum

Whether this tool is a function or a webhook (Only function tool supported right now)

functionwebhook

function*one of

Function definition and parameters

Response

Body

id*string (uuid)

created_at*string (date-time)

jobsarray of string (uuid)

IDs (if any) of jobs created as part of this request

Request

const response = await fetch('https://api-alpha.julep.ai/api/agents/{agent_id}/tools', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "function",
      "function": {
        "name": "text",
        "parameters": {}
      }
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-05-19T09:30:57.446Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Update a tool by id

Update agent tool definition

PUThttps://api-alpha.julep.ai/api/agents/{agent_id}/tools/{tool_id}

Authorization

Path parameters

agent_id*string (uuid)

tool_id*string (uuid)

Body

function*FunctionDef (object)

Response

Body

id*string (uuid)

updated_at*string (date-time)

jobsarray of string (uuid)

IDs (if any) of jobs created as part of this request

Request

const response = await fetch('https://api-alpha.julep.ai/api/agents/{agent_id}/tools/{tool_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "function": {
        "name": "text",
        "parameters": {}
      }
    }),
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "2024-05-19T09:30:57.446Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Delete a tool by id

Delete tool by id

DELETEhttps://api-alpha.julep.ai/api/agents/{agent_id}/tools/{tool_id}

Authorization

Path parameters

agent_id*string (uuid)

tool_id*string (uuid)

Response

Body

id*string (uuid)

deleted_at*string (date-time)

jobsarray of string (uuid)

IDs (if any) of jobs created as part of this request

Request

const response = await fetch('https://api-alpha.julep.ai/api/agents/{agent_id}/tools/{tool_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deleted_at": "2024-05-19T09:30:57.446Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

PreviousAgents API NextUsers

Last updated 1 month ago