diff --git a/docs/openapi/jan.yaml b/docs/openapi/jan.yaml index 43c07cb3cb..fd2a6fe44f 100644 --- a/docs/openapi/jan.yaml +++ b/docs/openapi/jan.yaml @@ -709,6 +709,19 @@ x-webhooks: application/json: schema: $ref: 'specs/models.yaml#/components/schemas/ModelObject' + AssistantObject: + post: + 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 + tags: + - Assistants + requestBody: + content: + application/json: + schema: + $ref: 'specs/assistants.yaml#/components/schemas/AssistantObject' MessageObject: post: summary: The message object diff --git a/docs/openapi/specs/assistant.yaml b/docs/openapi/specs/assistant.yaml deleted file mode 100644 index 95b4cd22dd..0000000000 --- a/docs/openapi/specs/assistant.yaml +++ /dev/null @@ -1,59 +0,0 @@ -AssistantObject: - type: object - properties: - avatar: - type: string - description: "URL of the assistant's avatar. Jan-specific property." - example: "https://lala.png" - id: - type: string - description: "The identifier of the assistant." - example: "asst_abc123" - object: - type: string - description: "Type of the object, indicating it's an assistant." - default: "assistant" - version: - type: integer - description: "Version number of the assistant." - example: 1 - created_at: - type: integer - format: int64 - description: "Unix timestamp representing the creation time of the assistant." - name: - type: string - description: "Name of the assistant." - example: "Math Tutor" - description: - type: string - description: "Description of the assistant. Can be null." - models: - type: array - description: "List of models associated with the assistant. Jan-specific property." - items: - type: object - properties: - model_id: - type: string - # Additional properties for models can be added here - events: - type: object - description: "Event subscription settings for the assistant." - properties: - in: - type: array - items: - type: string - out: - type: array - items: - type: string - # If there are specific event types, they can be detailed here - metadata: - type: object - description: "Metadata associated with the assistant." - required: - - name - - models - - events \ No newline at end of file diff --git a/docs/openapi/specs/assistants.yaml b/docs/openapi/specs/assistants.yaml new file mode 100644 index 0000000000..bb9c964550 --- /dev/null +++ b/docs/openapi/specs/assistants.yaml @@ -0,0 +1,61 @@ +components: + schemas: + AssistantObject: + type: object + properties: + avatar: + type: string + description: "URL of the assistant's avatar. Jan-specific property." + example: "https://lala.png" + id: + type: string + description: "The identifier of the assistant." + example: "asst_abc123" + object: + type: string + description: "Type of the object, indicating it's an assistant." + default: "assistant" + version: + type: integer + description: "Version number of the assistant." + example: 1 + created_at: + type: integer + format: int64 + description: "Unix timestamp representing the creation time of the assistant." + name: + type: string + description: "Name of the assistant." + example: "Math Tutor" + description: + type: string + description: "Description of the assistant. Can be null." + models: + type: array + description: "List of models associated with the assistant. Jan-specific property." + items: + type: object + properties: + model_id: + type: string + # Additional properties for models can be added here + events: + type: object + description: "Event subscription settings for the assistant." + properties: + in: + type: array + items: + type: string + out: + type: array + items: + type: string + # If there are specific event types, they can be detailed here + metadata: + type: object + description: "Metadata associated with the assistant." + required: + - name + - models + - events \ No newline at end of file