Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(documentation): Init #984

Draft
wants to merge 35 commits into
base: dev
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
f9ebbf3
feat(documentation): Init
creatorrr Dec 23, 2024
6e1d59a
wip(documentation): Work on mintlify docs
creatorrr Dec 24, 2024
30835e3
docs(mintlify): Add task walkthrough & other misc improvements
HamadaSalhab Jan 9, 2025
61b3377
Merge pull request #1036 from julep-ai/d/docs-improvement
creatorrr Jan 9, 2025
d9c37cd
wip(docs): mintlify sidebar
creatorrr Jan 15, 2025
06bc976
Merge branch 'dev' into mintlify-docs
creatorrr Jan 15, 2025
9ef7044
feat(docs): finalised mintlify sidebar
Vedantsahai18 Jan 16, 2025
9e9ff9d
docs(integration): intital draft of supported models added
Vedantsahai18 Jan 16, 2025
13fd68b
chore:supported model page update
Vedantsahai18 Jan 17, 2025
96e7afd
wip: added note to support model
Vedantsahai18 Jan 17, 2025
3470cbd
wip: initial integration docuemntaion added + icons to sidebar
Vedantsahai18 Jan 17, 2025
171ebc4
doc(documentation): ADd trip planning tutorial page
HamadaSalhab Jan 17, 2025
9a65a94
doc(documentation): Add browser use tutorial page
HamadaSalhab Jan 17, 2025
a5ece05
doc(documentation): Add rag workflow tutorial page
HamadaSalhab Jan 17, 2025
d211aff
doc(documentation): Add video processing tutorial page
HamadaSalhab Jan 17, 2025
0764f3b
wip: complete integration pages
Vedantsahai18 Jan 17, 2025
c4fc0c2
chore: misc fixes
Vedantsahai18 Jan 17, 2025
8a45bc2
wip: misc fixes
Vedantsahai18 Jan 18, 2025
f309f31
chore: minro refactor
Vedantsahai18 Jan 18, 2025
2d04a86
Merge pull request #1064 from julep-ai/mintlify-vedant
Vedantsahai18 Jan 18, 2025
738d0a7
Merge branch 'mintlify-docs' into d/tutorials
HamadaSalhab Jan 18, 2025
ff25d07
chore: python expr placeholder
Vedantsahai18 Jan 19, 2025
41d19b5
chore: misc fix
Vedantsahai18 Jan 19, 2025
b476438
chore(docs): Refactor browser-use tutorial
HamadaSalhab Jan 19, 2025
a2933cb
chore(docs): Refactor crawling-rag tutorial
HamadaSalhab Jan 19, 2025
85db166
chore(docs): Refactor trip-planning tutorial
HamadaSalhab Jan 19, 2025
5daaec9
chore(docs): Refactor video-processing tutorial
HamadaSalhab Jan 19, 2025
9fc25df
chore(docs:) Remove multi-agent-research tutorial
HamadaSalhab Jan 20, 2025
db4e4ab
Merge pull request #1067 from julep-ai/d/tutorials
Vedantsahai18 Jan 20, 2025
813836a
misc fix
Vedantsahai18 Jan 20, 2025
3907fcd
wip: get started + advanve topics
Vedantsahai18 Jan 20, 2025
525ff85
Merge pull request #1070 from julep-ai/mintlify-vedant
Vedantsahai18 Jan 21, 2025
028da2f
wip(documentation): Notes on agents
creatorrr Jan 21, 2025
6c277f1
wip(documentation): added agent concept structure
Vedantsahai18 Jan 21, 2025
a50cae1
wip(documentation): agent structure finalized
Vedantsahai18 Jan 21, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Julep Mintlify Documentation

## Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command

```
npm i -g mintlify
```

Run the following command at the root of your documentation (where mint.json is)

```
mintlify dev
```

### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/create-or-update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /agents/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /agents
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /agents/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /agents/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /agents
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/patch.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /agents/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/tools/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /agents/{id}/tools
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/tools/delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /agents/{id}/tools/{child_id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/tools/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /agents/{id}/tools
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/tools/patch.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /agents/{id}/tools/{child_id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/tools/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /agents/{id}/tools/{child_id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/agents/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /agents/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/agents/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /agents/{id}/docs
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/agents/delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /agents/{id}/docs/{child_id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/agents/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /agents/{id}/docs
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/agents/search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /agents/{id}/search
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/embed.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /embed
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /docs/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/users/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /users/{id}/docs
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/users/delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /users/{id}/docs/{child_id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/users/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /users/{id}/docs
---
3 changes: 3 additions & 0 deletions documentation/api-reference/docs/users/search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /users/{id}/search
---
3 changes: 3 additions & 0 deletions documentation/api-reference/executions/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /executions
---
3 changes: 3 additions & 0 deletions documentation/api-reference/executions/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /executions/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/executions/transitions-stream.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /executions/{id}/transitions.stream
---
3 changes: 3 additions & 0 deletions documentation/api-reference/executions/transitions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /executions/{id}/transitions
---
3 changes: 3 additions & 0 deletions documentation/api-reference/executions/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /executions/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/files/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /files
---
3 changes: 3 additions & 0 deletions documentation/api-reference/files/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /files/{id}
---
51 changes: 51 additions & 0 deletions documentation/api-reference/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Introduction
description: 'Introduction to the Julep REST API'
---

<CardGroup cols={2}>
<Card
title="Agent Endpoints"
icon="robot"
href="/api-reference/agents/create"
>
Create, update, and manage AI agents
</Card>
<Card
title="Task Endpoints"
icon="list-check"
href="/api-reference/tasks/create"
>
Create and execute AI tasks and workflows
</Card>
<Card
title="Session Endpoints"
icon="comments"
href="/api-reference/sessions/create"
>
Manage conversation sessions and state
</Card>
<Card
title="User Endpoints"
icon="plug"
href="/api-reference/users/create"
>
Register and manage users
</Card>
</CardGroup>

## Authentication

<Note>
Authentication is done via API keys.
</Note>

API keys are used to authenticate requests to the Julep API. They can be created in the [Julep dashboard](https://dashboard.julep.ai).

To create an API key, go to the Julep dashboard and navigate to the "API Keys" section.

To use an API key, include it in the `Authorization` header of your request.

```
Authorization: Bearer YOUR_API_KEY
```
3 changes: 3 additions & 0 deletions documentation/api-reference/jobs/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /jobs/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/chat.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /sessions/{id}/chat
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/create-or-update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /sessions/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /sessions
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /sessions/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /sessions/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/history/delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /sessions/{id}/history
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/history/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /sessions/{id}/history
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /sessions
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/patch.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /sessions/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/sessions/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /sessions/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/tasks/create-or-update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /agents/{parent_id}/tasks/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/tasks/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /agents/{id}/tasks
---
3 changes: 3 additions & 0 deletions documentation/api-reference/tasks/delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /agents/{id}/tasks/{child_id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/tasks/executions/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /tasks/{id}/executions
---
3 changes: 3 additions & 0 deletions documentation/api-reference/tasks/executions/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /tasks/{id}/executions
---
3 changes: 3 additions & 0 deletions documentation/api-reference/tasks/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /tasks/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/tasks/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /agents/{id}/tasks
---
3 changes: 3 additions & 0 deletions documentation/api-reference/tasks/patch.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /agents/{id}/tasks/{child_id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/tasks/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /agents/{id}/tasks/{child_id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/users/create-or-update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /users/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/users/create.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: post /users
---
3 changes: 3 additions & 0 deletions documentation/api-reference/users/delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: delete /users/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/users/get.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /users/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/users/list.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: get /users
---
3 changes: 3 additions & 0 deletions documentation/api-reference/users/patch.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: patch /users/{id}
---
3 changes: 3 additions & 0 deletions documentation/api-reference/users/update.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: put /users/{id}
---
Loading
Loading