Post accounts aiagentsstream

POST /accounts/{accountId}/ai/agents/stream

cURL

cURL

curl --request POST \
  --url https://api.checklyhq.com/accounts/{accountId}/ai/agents/stream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {}
  ],
  "agent": "basic"
}
'

import requests

url = "https://api.checklyhq.com/accounts/{accountId}/ai/agents/stream"

payload = {
    "messages": [{}],
    "agent": "basic"
}
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({messages: [{}], agent: 'basic'})
};

fetch('https://api.checklyhq.com/accounts/{accountId}/ai/agents/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://api.checklyhq.com/accounts/{accountId}/ai/agents/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([
    'messages' => [
        [
                
        ]
    ],
    'agent' => 'basic'
  ]),
  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://api.checklyhq.com/accounts/{accountId}/ai/agents/stream"

	payload := strings.NewReader("{\n  \"messages\": [\n    {}\n  ],\n  \"agent\": \"basic\"\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://api.checklyhq.com/accounts/{accountId}/ai/agents/stream")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messages\": [\n    {}\n  ],\n  \"agent\": \"basic\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/accounts/{accountId}/ai/agents/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  \"messages\": [\n    {}\n  ],\n  \"agent\": \"basic\"\n}"

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

default

"<string>"

Authorizations

Authorization · string · header · required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Path Parameters

accountId · string · required

Body

application/json

messages · object[] · required

Minimum array length: 1

agent · enum<string> · default: basic

Available options: basic, checkly_config_generator, playwright_check_generator

Response

default - application/json

Successful

The response is of type string.