jan/docs/docs/specs/messages.md

title
Messages

:::warning

Draft Specification: functionality has not been implemented yet.

Feedback: HackMD: Threads Spec

:::

Messages are within threads and capture additional metadata.

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/messages

Message Object

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/messages/object

{
  // Jan specific properties
  "updatedAt": "...", // that's it I think

  // OpenAI compatible properties: https://platform.openai.com/docs/api-reference/messages)
  "id": "msg_dKYDWyQvtjDBi3tudL1yWKDa",
  "object": "thread.message",
  "created_at": 1698983503,
  "thread_id": "thread_RGUhOuO9b2nrktrmsQ2uSR6I",
  "role": "assistant",
  "content": [
    {
      "type": "text",
      "text": {
        "value": "Hi! How can I help you today?",
        "annotations": []
      }
    }
  ],
  "file_ids": [],
  "assistant_id": "asst_ToSF7Gb04YMj8AMMm50ZLLtY",
  "run_id": "run_BjylUJgDqYK9bOhy4yjAiMrn",
  "metadata": {}
}

Messages API

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/messages

Get list message

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/messages/getMessage

• Example request

  curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id} \
    -H "Content-Type: application/json"

• Example response

{
  "id": "msg_abc123",
  "object": "thread.message",
  "created_at": 1699017614,
  "thread_id": "thread_abc123",
  "role": "user",
  "content": [
    {
      "type": "text",
      "text": {
        "value": "How does AI work? Explain it in simple terms.",
        "annotations": []
      }
    }
  ],
  "file_ids": [],
  "assistant_id": null,
  "run_id": null,
  "metadata": {}
}

Create message

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/messages/createMessage

• Example request

  curl -X POST {JAN_URL}/v1/threads/{thread_id}/messages \
    -H "Content-Type: application/json" \
    -d '{
      "role": "user",
      "content": "How does AI work? Explain it in simple terms."
    }'

• Example response

  {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "thread_id": "thread_abc123",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }

Get message

OpenAI Equivalent: https://platform.openai.com/docs/api-reference/assistants/listAssistants

• Example request

  curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id} \
    -H "Content-Type: application/json"

• Example response

  {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "thread_id": "thread_abc123",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }

Modify message

Jan: TODO: Do we need to modify message? Or let user create new message?

Get message file

OpenAI Equivalent: https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files/{file_id}

• Example request

  curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id}/files/{file_id} \
    -H "Content-Type: application/json"

• Example response

  {
    "id": "file-abc123",
    "object": "thread.message.file",
    "created_at": 1699061776,
    "message_id": "msg_abc123"
  }

List message files

OpenAI Equivalent: https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files

- Example request
```shell
  curl {JAN_URL}/v1/threads/{thread_id}/messages/{message_id}/files/{file_id} \
    -H "Content-Type: application/json"

• Example response

  {
    "id": "file-abc123",
    "object": "thread.message.file",
    "created_at": 1699061776,
    "message_id": "msg_abc123"
  }