PATCH
/
samples
/
{id}
/
messages
/
{message_id}
curl --request PATCH \
  --url https://app.happyrobot.ai/api/v1/samples/{id}/messages/{message_id} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "role": "system",
  "content": "<string>",
  "tool_calls": [
    {
      "type": "<string>",
      "id": "<string>",
      "function": {
        "name": "<string>",
        "arguments": "<string>"
      }
    }
  ],
  "interrupted_thoughts": "<string>",
  "discard": true
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "assistant_id": "<string>",
  "call_id": "<string>",
  "split": "train",
  "created": "<string>",
  "status": "to_review",
  "messages": [
    {
      "id": "<string>",
      "role": "system",
      "content": "<string>",
      "tool_calls": [
        {
          "type": "<string>",
          "id": "<string>",
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          }
        }
      ],
      "name": "<string>",
      "tool_call_id": "<string>",
      "start": 123,
      "end": 123,
      "interrupted_thoughts": "<string>",
      "discard": true
    }
  ]
}

Headers

authorization
string
required

Path Parameters

id
string
required
message_id
string
required

Body

application/json
role
enum<string>

Role of the message.

Available options:
system,
assistant,
user,
tool
content
string
tool_calls
object[]
interrupted_thoughts
string | null
discard
boolean

Response

200 - application/json
id
string
required
organization_id
string
required
assistant_id
string
required
call_id
string
split
enum<string>
required
Available options:
train,
test
created
string
required
status
enum<string>
required
Available options:
to_review,
reviewed,
final
messages
object[]
required

Was this page helpful?

Update an existing exampleCreate a new sample