PUT
/
document
/
{id}
curl --request PUT \
  --url https://{api-address}.org.machina.gg/document/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '{
  "value": {
    "messages": [
      {
        "content": "How do the odds look for Man City vs Real Madrid?",
        "date": "2024-12-07T23:09:39.784Z",
        "role": "user"
      },
      {
        "content": "Manchester City vs Real Madrid",
        "date": "2024-12-07T23:11:39.784Z",
        "role": "assistant"
      }
    ]
  },
  "metadata": {},
  "status": "active"
}'
{
  "data": {
    "_id": "67e1fc8c2a5ade8c69c03fe7",
    "created": "Tue, 25 Mar 2025 00:45:00 GMT",
    "embed-vector": false,
    "metadata": {
      "agent_id": "123"
    },
    "name": "New test document",
    "status": null,
    "updated": "Tue, 25 Mar 2025 01:54:59 GMT",
    "value": {
      "messages": [
        {
          "content": "How do the odds look for Man City vs Real Madrid?",
          "date": "2024-12-07T23:09:39.784Z",
          "role": "user"
        },
        {
          "content": "Manchester City vs Real Madrid",
          "date": "2024-12-07T23:11:39.784Z",
          "role": "assistant"
        }
      ]
    }
  },
  "message": "document updated",
  "status": true
}

Authorizations

​
x-api-token
string
header
required

API key authentication

Path Parameters

​
id
string
required

Unique ID of the document to update

Body

application/json
​
value
object

The main data of the document, can be any type (string, object, array, etc.)

Example:
{
  "messages": [
    {
      "content": "How do the odds look for Man City vs Real Madrid?",
      "date": "2024-12-07T23:09:39.784Z",
      "role": "user"
    },
    {
      "content": "Manchester City vs Real Madrid",
      "date": "2024-12-07T23:11:39.784Z",
      "role": "assistant"
    }
  ]
}
​
metadata
object

Additional metadata for the document

​
status
enum<string>

Updated status of the document

Available options:
active,
draft,
archived

Response

200
application/json
Document updated successfully
​
data
object
​
message
string

Success message

Example:

"document updated"

​
status
boolean

Operation status

Example:

true