Chat with agent via stream

curl --request POST \
  --url https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "threadId": "<string>",
  "noExecute": true,
  "streamModes": [
    "<string>"
  ]
}
'

import requests

url = "https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream"

payload = {
    "message": "<string>",
    "threadId": "<string>",
    "noExecute": True,
    "streamModes": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    message: '<string>',
    threadId: '<string>',
    noExecute: true,
    streamModes: ['<string>']
  })
};

fetch('https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream', 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://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream",
  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([
    'message' => '<string>',
    'threadId' => '<string>',
    'noExecute' => true,
    'streamModes' => [
        '<string>'
    ]
  ]),
  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 := "https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream"

	payload := strings.NewReader("{\n  \"message\": \"<string>\",\n  \"threadId\": \"<string>\",\n  \"noExecute\": true,\n  \"streamModes\": [\n    \"<string>\"\n  ]\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("https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"<string>\",\n  \"threadId\": \"<string>\",\n  \"noExecute\": true,\n  \"streamModes\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": \"<string>\",\n  \"threadId\": \"<string>\",\n  \"noExecute\": true,\n  \"streamModes\": [\n    \"<string>\"\n  ]\n}"

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

[
  {}
]

POST

ai-agent

{projectId}

chat

stream

Chat with agent via stream

curl --request POST \
  --url https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": "<string>",
  "threadId": "<string>",
  "noExecute": true,
  "streamModes": [
    "<string>"
  ]
}
'

import requests

url = "https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream"

payload = {
    "message": "<string>",
    "threadId": "<string>",
    "noExecute": True,
    "streamModes": ["<string>"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    message: '<string>',
    threadId: '<string>',
    noExecute: true,
    streamModes: ['<string>']
  })
};

fetch('https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream', 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://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream",
  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([
    'message' => '<string>',
    'threadId' => '<string>',
    'noExecute' => true,
    'streamModes' => [
        '<string>'
    ]
  ]),
  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 := "https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream"

	payload := strings.NewReader("{\n  \"message\": \"<string>\",\n  \"threadId\": \"<string>\",\n  \"noExecute\": true,\n  \"streamModes\": [\n    \"<string>\"\n  ]\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("https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"<string>\",\n  \"threadId\": \"<string>\",\n  \"noExecute\": true,\n  \"streamModes\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://partner.peaka.studio/api/v1/ai-agent/{projectId}/chat/stream")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": \"<string>\",\n  \"threadId\": \"<string>\",\n  \"noExecute\": true,\n  \"streamModes\": [\n    \"<string>\"\n  ]\n}"

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

[
  {}
]

Authorizations

Authorization

string

header

required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

projectId

string

required

Body

application/json

message

string

threadId

string

noExecute

boolean

streamModes

string[]

Response

200 - text/event-stream

Chat with agent List ai-agent threads

⌘I

API Documentation

Organization -- Organizations

Organization -- Workspaces

Organization -- Projects

Projects (Deprecated)

Projects -- Api Key

Connections

Data -- Catalogs

Data -- Internal Tables

Data -- Queries

Data -- Query Folders

Data -- Semantic Catalogs

Data -- Cache

Data -- Exports

Data -- Parametric Tables

Embedded Peaka Api

Supported Drivers

Data -- Metadata

AI -- AgentV2

Data -- SQL

Data -- Materialized Queries

Chat with agent via stream

Authorizations

Path Parameters

Body

Response