Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Julep Users API

The Users API from Julep — 5 operation(s) for users.

Julep Users API is one of 12 APIs that Julep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 12 operations across 5 paths, and defines 21 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.

12 operations 5 paths 21 schemas 3 DELETE3 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.julep.ai/api
Authentication
API Key, API Key
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Julep Users 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 12

Across 5 paths, the API surfaces 12 operations — 3 DELETE, 3 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 12
GET
/users
List users (paginated)
UsersRoute_list 5 params → 200
POST
/users
Create a new user
UsersRoute_create body → 201
POST
/users/{id}
Create or update a user
UsersRoute_createOrUpdate 1 param body → 200
PUT
/users/{id}
Update an existing user by id (overwrite existing values)
UsersRoute_update 1 param body → 200
PATCH
/users/{id}
Update an existing user by id (merge with existing values)
UsersRoute_patch 1 param body → 200
DELETE
/users/{id}
Delete a user by id
UsersRoute_delete 1 param → 202
GET
/users/{id}
Get a user by id
UsersRoute_get 1 param → 200
POST
/users/{id}/docs
Create a Doc for this User
UserDocsRoute_create 1 param body → 201
GET
/users/{id}/docs
List Docs owned by a User
UserDocsRoute_list 7 params → 200
DELETE
/users/{id}/docs
Bulk delete Docs owned by a User
UserDocsRoute_deleteBulk 1 param body → 202
DELETE
/users/{id}/docs/{child_id}
Delete a Doc for this User
UserDocsRoute_delete 2 params → 202
POST
/users/{id}/search
Search Docs owned by a User
UserDocsSearchRoute_search 1 param body → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Docs.HybridDocSearchRequest (11 properties), Docs.Doc (10 properties), Users.User (7 properties), Docs.VectorDocSearchRequest (6 properties). Each schema is shown below with its type and property counts.

Docs.DocReference
object
6 properties 4 required
Docs.BulkDeleteDocsRequest
object
2 properties 2 required
Common.uuid
string
Common.ResourceDeletedResponse
object
3 properties 3 required
Users.UpdateUserRequest
object
Payload for updating a user
4 properties 2 required
Docs.VectorDocSearchRequest
object
6 properties 5 required
Common.canonicalName
string
For canonical names (machine-friendly identifiers) Must start with a letter and can only contain letters, numbers, and underscores
Users.CreateUserRequest
object
Payload for creating a user (and associated documents)
4 properties 2 required
Common.limit
integer
Limit the number of results
Docs.TextOnlyDocSearchRequest
object
6 properties 6 required
Docs.Doc
object
10 properties 5 required
Common.content
string
Contents of a document
Docs.Snippet
object
3 properties 2 required
Users.PatchUserRequest
object
Payload for patching a user
4 properties
Docs.DocSearchResponse
object
2 properties 2 required
Common.identifierSafeUnicode
string
For Unicode character safety See: https://unicode.org/reports/tr31/ See: https://www.unicode.org/reports/tr39/IdentifierCharacters
Common.offset
integer
Offset to apply to the results
Users.User
object
7 properties 5 required
Docs.CreateDocRequest
object
Payload for creating a doc
4 properties 3 required
Docs.DocOwner
object
2 properties 2 required
Docs.HybridDocSearchRequest
object
11 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

julep-users-api-openapi.yml Raw ↑

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 Sessions API
Julep Tasks API