Get Metamessages

Get metamessages with flexible filtering.

• Filter by user only: No additional parameters needed
• Filter by session: Provide session_id
• Filter by message: Provide message_id (and session_id)
• Filter by type: Provide label
• Filter by metadata: Provide filter object

POST /v1/apps/{app_id}/users/{user_id}/metamessages/list

JavaScript

JavaScript

import Honcho from 'honcho-ai';

const client = new Honcho({
  apiKey: process.env['HONCHO_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const metamessage of client.apps.users.metamessages.list('app_id', 'user_id')) {
    console.log(metamessage.id);
  }
}

main();

import os
from honcho import Honcho

client = Honcho(
    api_key=os.environ.get("HONCHO_API_KEY"),  # This is the default and can be omitted
)
page = client.apps.users.metamessages.list(
    user_id="user_id",
    app_id="app_id",
)
page = page.items[0]
print(page.id)

curl --request POST \
  --url http://localhost:8000/v1/apps/{app_id}/users/{user_id}/metamessages/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metamessage_type": "<string>",
  "session_id": "<string>",
  "message_id": "<string>",
  "filter": {}
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8000",
  CURLOPT_URL => "http://localhost:8000/v1/apps/{app_id}/users/{user_id}/metamessages/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'metamessage_type' => '<string>',
    'session_id' => '<string>',
    'message_id' => '<string>',
    'filter' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8000/v1/apps/{app_id}/users/{user_id}/metamessages/list"

	payload := strings.NewReader("{\n  \"metamessage_type\": \"<string>\",\n  \"session_id\": \"<string>\",\n  \"message_id\": \"<string>\",\n  \"filter\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:8000/v1/apps/{app_id}/users/{user_id}/metamessages/list")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"metamessage_type\": \"<string>\",\n  \"session_id\": \"<string>\",\n  \"message_id\": \"<string>\",\n  \"filter\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:8000/v1/apps/{app_id}/users/{user_id}/metamessages/list")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"metamessage_type\": \"<string>\",\n  \"session_id\": \"<string>\",\n  \"message_id\": \"<string>\",\n  \"filter\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "id": "<string>",
      "label": "<string>",
      "content": "<string>",
      "user_id": "<string>",
      "app_id": "<string>",
      "session_id": "<string>",
      "message_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "metamessage_type": "<string>",
      "metadata": {}
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2,
  "pages": 1
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

app_id · string · required

ID of the app

user_id · string · required

ID of the user

Query Parameters

reverse · boolean | null · default: false

Whether to reverse the order of results

page · integer · default: 1

Page number

Required range: x >= 1

size · integer · default: 50

Page size

Required range: 1 <= x <= 100

Body

application/json

Filtering options for the metamessages list

metamessage_type · string | null

session_id · string | null

message_id · string | null

filter · Filter · object | null

Response

200

application/json

Successful Response

items · Metamessage · object[] · required

Show child attributes

total · integer · required

Required range: x >= 0

page · integer · required

Required range: x >= 1

size · integer · required

Required range: x >= 1

pages · integer

Required range: x >= 0