Calls Query Stream

POST /calls/stream_query

Calls Query Stream

cURL

curl --request POST \
  --url https://api.example.com/calls/stream_query \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project_id": "<string>",
  "filter": {
    "op_names": [
      "<string>"
    ],
    "input_refs": [
      "<string>"
    ],
    "output_refs": [
      "<string>"
    ],
    "parent_ids": [
      "<string>"
    ],
    "trace_ids": [
      "<string>"
    ],
    "call_ids": [
      "<string>"
    ],
    "thread_ids": [
      "<string>"
    ],
    "turn_ids": [
      "<string>"
    ],
    "trace_roots_only": true,
    "wb_user_ids": [
      "<string>"
    ],
    "wb_run_ids": [
      "<string>"
    ]
  },
  "limit": 123,
  "offset": 123,
  "sort_by": [
    {
      "field": "<string>"
    }
  ],
  "query": {
    "$expr": {
      "$and": [
        {
          "$literal": "<string>"
        }
      ]
    }
  },
  "include_costs": false,
  "include_feedback": false,
  "include_storage_size": false,
  "include_total_storage_size": false,
  "include_usernames": false,
  "columns": [
    "<string>"
  ],
  "expand_columns": [
    "inputs.self.message",
    "inputs.model.prompt"
  ],
  "return_expanded_column_values": true
}
'

import requests

url = "https://api.example.com/calls/stream_query"

payload = {
    "project_id": "<string>",
    "filter": {
        "op_names": ["<string>"],
        "input_refs": ["<string>"],
        "output_refs": ["<string>"],
        "parent_ids": ["<string>"],
        "trace_ids": ["<string>"],
        "call_ids": ["<string>"],
        "thread_ids": ["<string>"],
        "turn_ids": ["<string>"],
        "trace_roots_only": True,
        "wb_user_ids": ["<string>"],
        "wb_run_ids": ["<string>"]
    },
    "limit": 123,
    "offset": 123,
    "sort_by": [{ "field": "<string>" }],
    "query": { "$expr": { "$and": [{ "$literal": "<string>" }] } },
    "include_costs": False,
    "include_feedback": False,
    "include_storage_size": False,
    "include_total_storage_size": False,
    "include_usernames": False,
    "columns": ["<string>"],
    "expand_columns": ["inputs.self.message", "inputs.model.prompt"],
    "return_expanded_column_values": True
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project_id: '<string>',
    filter: {
      op_names: ['<string>'],
      input_refs: ['<string>'],
      output_refs: ['<string>'],
      parent_ids: ['<string>'],
      trace_ids: ['<string>'],
      call_ids: ['<string>'],
      thread_ids: ['<string>'],
      turn_ids: ['<string>'],
      trace_roots_only: true,
      wb_user_ids: ['<string>'],
      wb_run_ids: ['<string>']
    },
    limit: 123,
    offset: 123,
    sort_by: [{field: '<string>'}],
    query: {$expr: {$and: [{$literal: '<string>'}]}},
    include_costs: false,
    include_feedback: false,
    include_storage_size: false,
    include_total_storage_size: false,
    include_usernames: false,
    columns: ['<string>'],
    expand_columns: ['inputs.self.message', 'inputs.model.prompt'],
    return_expanded_column_values: true
  })
};

fetch('https://api.example.com/calls/stream_query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/calls/stream_query",
  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([
    'project_id' => '<string>',
    'filter' => [
        'op_names' => [
                '<string>'
        ],
        'input_refs' => [
                '<string>'
        ],
        'output_refs' => [
                '<string>'
        ],
        'parent_ids' => [
                '<string>'
        ],
        'trace_ids' => [
                '<string>'
        ],
        'call_ids' => [
                '<string>'
        ],
        'thread_ids' => [
                '<string>'
        ],
        'turn_ids' => [
                '<string>'
        ],
        'trace_roots_only' => true,
        'wb_user_ids' => [
                '<string>'
        ],
        'wb_run_ids' => [
                '<string>'
        ]
    ],
    'limit' => 123,
    'offset' => 123,
    'sort_by' => [
        [
                'field' => '<string>'
        ]
    ],
    'query' => [
        '$expr' => [
                '$and' => [
                                [
                                                                '$literal' => '<string>'
                                ]
                ]
        ]
    ],
    'include_costs' => false,
    'include_feedback' => false,
    'include_storage_size' => false,
    'include_total_storage_size' => false,
    'include_usernames' => false,
    'columns' => [
        '<string>'
    ],
    'expand_columns' => [
        'inputs.self.message',
        'inputs.model.prompt'
    ],
    'return_expanded_column_values' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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 := "https://api.example.com/calls/stream_query"

	payload := strings.NewReader("{\n  \"project_id\": \"<string>\",\n  \"filter\": {\n    \"op_names\": [\n      \"<string>\"\n    ],\n    \"input_refs\": [\n      \"<string>\"\n    ],\n    \"output_refs\": [\n      \"<string>\"\n    ],\n    \"parent_ids\": [\n      \"<string>\"\n    ],\n    \"trace_ids\": [\n      \"<string>\"\n    ],\n    \"call_ids\": [\n      \"<string>\"\n    ],\n    \"thread_ids\": [\n      \"<string>\"\n    ],\n    \"turn_ids\": [\n      \"<string>\"\n    ],\n    \"trace_roots_only\": true,\n    \"wb_user_ids\": [\n      \"<string>\"\n    ],\n    \"wb_run_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"limit\": 123,\n  \"offset\": 123,\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"include_costs\": false,\n  \"include_feedback\": false,\n  \"include_storage_size\": false,\n  \"include_total_storage_size\": false,\n  \"include_usernames\": false,\n  \"columns\": [\n    \"<string>\"\n  ],\n  \"expand_columns\": [\n    \"inputs.self.message\",\n    \"inputs.model.prompt\"\n  ],\n  \"return_expanded_column_values\": true\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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("https://api.example.com/calls/stream_query")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project_id\": \"<string>\",\n  \"filter\": {\n    \"op_names\": [\n      \"<string>\"\n    ],\n    \"input_refs\": [\n      \"<string>\"\n    ],\n    \"output_refs\": [\n      \"<string>\"\n    ],\n    \"parent_ids\": [\n      \"<string>\"\n    ],\n    \"trace_ids\": [\n      \"<string>\"\n    ],\n    \"call_ids\": [\n      \"<string>\"\n    ],\n    \"thread_ids\": [\n      \"<string>\"\n    ],\n    \"turn_ids\": [\n      \"<string>\"\n    ],\n    \"trace_roots_only\": true,\n    \"wb_user_ids\": [\n      \"<string>\"\n    ],\n    \"wb_run_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"limit\": 123,\n  \"offset\": 123,\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"include_costs\": false,\n  \"include_feedback\": false,\n  \"include_storage_size\": false,\n  \"include_total_storage_size\": false,\n  \"include_usernames\": false,\n  \"columns\": [\n    \"<string>\"\n  ],\n  \"expand_columns\": [\n    \"inputs.self.message\",\n    \"inputs.model.prompt\"\n  ],\n  \"return_expanded_column_values\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/calls/stream_query")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project_id\": \"<string>\",\n  \"filter\": {\n    \"op_names\": [\n      \"<string>\"\n    ],\n    \"input_refs\": [\n      \"<string>\"\n    ],\n    \"output_refs\": [\n      \"<string>\"\n    ],\n    \"parent_ids\": [\n      \"<string>\"\n    ],\n    \"trace_ids\": [\n      \"<string>\"\n    ],\n    \"call_ids\": [\n      \"<string>\"\n    ],\n    \"thread_ids\": [\n      \"<string>\"\n    ],\n    \"turn_ids\": [\n      \"<string>\"\n    ],\n    \"trace_roots_only\": true,\n    \"wb_user_ids\": [\n      \"<string>\"\n    ],\n    \"wb_run_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"limit\": 123,\n  \"offset\": 123,\n  \"sort_by\": [\n    {\n      \"field\": \"<string>\"\n    }\n  ],\n  \"query\": {\n    \"$expr\": {\n      \"$and\": [\n        {\n          \"$literal\": \"<string>\"\n        }\n      ]\n    }\n  },\n  \"include_costs\": false,\n  \"include_feedback\": false,\n  \"include_storage_size\": false,\n  \"include_total_storage_size\": false,\n  \"include_usernames\": false,\n  \"columns\": [\n    \"<string>\"\n  ],\n  \"expand_columns\": [\n    \"inputs.self.message\",\n    \"inputs.model.prompt\"\n  ],\n  \"return_expanded_column_values\": true\n}"

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

422

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

Authorizations

HTTPBasicHTTPBearer

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

accept · string · default: application/jsonl

Body

application/json

project_id · string · required

filter · CallsFilter · object | null

Show child attributes

limit · integer | null

offset · integer | null

sort_by · SortBy · object[] | null

Show child attributes

query · Query · object | null

Show child attributes

include_costs · boolean | null · default: false

Beta, subject to change. If true, the response will include any model costs for each call.

include_feedback · boolean | null · default: false

Beta, subject to change. If true, the response will include feedback for each call.

include_storage_size · boolean | null · default: false

Beta, subject to change. If true, the response will include the storage size for a call.

include_total_storage_size · boolean | null · default: false

Beta, subject to change. If true, the response will include the total storage size for a trace.

include_usernames · boolean | null · default: false

If true, the response will attempt to resolve each call's wb_user_id to a username for the duration of this request.

columns · string[] | null

expand_columns · string[] | null

Columns to expand, i.e. refs to other objects

Example:

[
  "inputs.self.message",
  "inputs.model.prompt"
]

return_expanded_column_values · boolean | null · default: true

If true, the response will include raw values for expanded columns. If false, the response expand_columns will only be used for filtering and ordering. This is useful for clients that want to resolve refs themselves, e.g. for performance reasons.

Response

200

application/json

Successful Response