From 2187408604eaf2cd2b27033c650f85f6a373036f Mon Sep 17 00:00:00 2001 From: hieu-jan <150573299+hieu-jan@users.noreply.github.com> Date: Fri, 1 Dec 2023 10:30:33 +0900 Subject: [PATCH] docs: add assistant endpoint --- docs/openapi/jan.yaml | 41 ++++++++++++++++++++++++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/docs/openapi/jan.yaml b/docs/openapi/jan.yaml index fd2a6fe44..ee646f1eb 100644 --- a/docs/openapi/jan.yaml +++ b/docs/openapi/jan.yaml @@ -476,7 +476,46 @@ paths: - lang: "curl" source: | curl http://localhost:1337/v1/threads/{thread_id} + ### ASSISTANTS + /assistants/: + get: + operationId: listAssistants + tags: + - Assistants + summary: List assistants + description: | + Return a list of assistants. Equivalent to OpenAI's list assistants. + post: + operationId: createAssistants + tags: + - Assistants + summary: Create assistant + description: | + Create an assistant with a model and instructions. Equivalent to OpenAI's create assistants. + /assistants/{assistant_id}: + get: + operationId: getAssistant + tags: + - Assistants + summary: Retrieve assistants + description: | + Retrieves an assistant. Equivalent to OpenAI's retrieve assistants. + post: + operationId: modifyAssistant + tags: + - Assistants + summary: Modify assistant + description: | + Modifies an assistant. Equivalent to OpenAI's modify assistant. + delete: + operationId: deleteAssistant + tags: + - Assistants + summary: Delete assistant + description: | + Delete an assistant. Equivalent to OpenAI's delete assistant. + ### MESSAGES /threads/{thread_id}/messages: get: @@ -714,7 +753,7 @@ x-webhooks: summary: The assistant object description: | Build assistants that can call models and use tools to perform tasks. Equivalent to OpenAI's assistants object. - operationId: AssistantObject + operationId: AssistantObjects tags: - Assistants requestBody: