Users

API for creating and modifying Users

List all users

List users

List users 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/users

Authorization

api-key

Query parameters

Response

200

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

Body

application/json

items*array of User (object)

Request

JavaScriptCurl

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

Response

{
  "items": [
    {
      "name": "User",
      "about": "text",
      "created_at": "2024-05-19T18:13:20.884Z",
      "updated_at": "2024-05-19T18:13:20.884Z",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": {}
    }
  ]
}

---

Create a new user

Create a new user

Create a new user

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

Authorization

api-key

Body

application/json

User create options

namestring

Name of the user

aboutstring

About the user

docsarray of CreateDoc (object)

List of docs about user

metadataobject

(Optional) metadata

Response

201

User successfully created

Body

application/json

id*string (uuid)

created_at*string (date-time)

jobsarray of string (uuid)

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

Request

JavaScriptCurl

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

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-05-19T18:13:20.884Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

---

Get a specific user by id

Get details of the user

GEThttps://api-alpha.julep.ai/api/users/{user_id}

Authorization

api-key

Path parameters

user_id*string (uuid)

Response

200

Body

application/json

namestring

Name of the user

aboutstring

About the user

created_atstring (date-time)

User created at (RFC-3339 format)

updated_atstring (date-time)

User updated at (RFC-3339 format)

id*string (uuid)

User id (UUID)

metadataobject

(Optional) metadata

Request

JavaScriptCurl

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

Response

{
  "name": "User",
  "about": "text",
  "created_at": "2024-05-19T18:13:20.884Z",
  "updated_at": "2024-05-19T18:13:20.884Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "metadata": {}
}

---

Update a specific user by id

Update user parameters

PUThttps://api-alpha.julep.ai/api/users/{user_id}

Authorization

api-key

Path parameters

user_id*string (uuid)

Body

application/json

about*string

About the user

name*string

Name of the user

metadataobject

Optional metadata

Response

200

Body

application/json

id*string (uuid)

updated_at*string (date-time)

jobsarray of string (uuid)

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

Request

JavaScriptCurl

const response = await fetch('https://api-alpha.julep.ai/api/users/{user_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-19T18:13:20.884Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

---

Delete a specific user by id

Delete user

DELETEhttps://api-alpha.julep.ai/api/users/{user_id}

Authorization

api-key

Path parameters

user_id*string (uuid)

Response

202

Body

application/json

id*string (uuid)

deleted_at*string (date-time)

jobsarray of string (uuid)

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

Request

JavaScriptCurl

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

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deleted_at": "2024-05-19T18:13:20.884Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}