Docs

API for creating and modifying docs

Get all docs (for an agent or user)

Get docs of the agent

Sorted (created_at descending)

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

Authorization

api-key

Path parameters

agent_id*string (uuid)

Query parameters

Body

Response

200

Body

application/json

itemsarray of Doc (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "items": [
    {
      "title": "text",
      "content": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2024-11-05T19:03:10.356Z",
      "metadata": {}
    }
  ]
}

Get docs of the user

Sorted (created_at descending)

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

Authorization

api-key

Path parameters

user_id*string (uuid)

Query parameters

Body

Response

200

Body

application/json

itemsarray of Doc (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "items": [
    {
      "title": "text",
      "content": "text",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2024-11-05T19:03:10.356Z",
      "metadata": {}
    }
  ]
}

---

Create a new doc (for agent or user)

Create doc of the agent

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

Authorization

api-key

Path parameters

agent_id*string (uuid)

Body

application/json

title*string

Title describing what this bit of information contains

content*string

Information content

metadataobject

Optional metadata

Response

201

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

JavaScriptCurlPython

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

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-11-05T19:03:10.356Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Create doc of the user

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

Authorization

api-key

Path parameters

user_id*string (uuid)

Body

application/json

title*string

Title describing what this bit of information contains

content*string

Information content

metadataobject

Optional metadata

Response

201

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

JavaScriptCurlPython

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

Response

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-11-05T19:03:10.356Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

---

Delete a doc by id

Delete doc by id

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

Authorization

api-key

Path parameters

agent_id*string (uuid)

doc_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

JavaScriptCurlPython

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

Response

202

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deleted_at": "2024-11-05T19:03:10.356Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Delete doc by id

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

Authorization

api-key

Path parameters

user_id*string (uuid)

doc_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

JavaScriptCurlPython

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

Response

202

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "deleted_at": "2024-11-05T19:03:10.356Z",
  "jobs": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}