Skip to main content
PUT
/
threads
Create a new thread or update an existing thread
curl --request PUT \
  --url https://app.melodi.fyi/api/external/threads \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "messages": [
    {
      "role": "<string>",
      "type": "markdown",
      "externalId": "<string>",
      "content": "<string>",
      "jsonContent": {},
      "metadata": {}
    }
  ],
  "projectId": 123,
  "externalId": "<string>",
  "metadata": {},
  "externalUser": {
    "externalId": "<string>",
    "email": "<string>",
    "name": "<string>",
    "username": "<string>",
    "segments": {
      "team": "engineering",
      "role": "developer"
    }
  }
}
'
{
  "id": 123,
  "organizationId": 123,
  "project": {
    "id": 123,
    "name": "<string>"
  },
  "messages": [
    {
      "role": "<string>",
      "metadata": {},
      "externalId": "<string>",
      "type": "markdown",
      "content": "<string>",
      "jsonContent": {}
    }
  ],
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "externalUser": {
    "id": 123,
    "organizationId": 123,
    "externalId": "<string>",
    "segments": [
      {
        "id": 123,
        "organizationId": 123,
        "name": "<string>",
        "userSegmentTypeId": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "type": {
          "id": 123,
          "organizationId": 123,
          "name": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "email": "<string>",
    "username": "<string>"
  }
}

Authorizations

​
api-key
string
header
required

Your Melodi API key

Body

application/json

The full thread object

  • Create Thread with Project ID
  • Create Thread with Project Name
​
messages
object[]
required
​
projectId
integer
required
​
externalId
string
​
metadata
object
​
externalUser
object

Request object for creating or updating an external user

Response

Thread successfully created or updated

​
id
integer
required

Unique identifier for the thread

​
organizationId
integer
required

ID of the organization to which the thread belongs

​
project
object
required
​
messages
object[]
required
​
metadata
object
required

Metadata associated with the thread

​
createdAt
string<date-time>
required

Date when the thread was created

​
updatedAt
string<date-time>
required

Date when the thread was last updated

​
externalId
string | null

External thread ID

​
externalUser
object

Represents an external user. Note: The combination of organizationId and externalId must be unique.