Send a message to the granted deployment and stream the answer

POST

connect

interact

stream

curl --request POST \
  --url https://api.paygent.payman.ai/connect/interact/stream \
  --header 'Content-Type: application/json' \
  --header 'x-paygent-connect-app-key: <api-key>' \
  --header 'x-paygent-connect-grant: <api-key>' \
  --data '
{
  "userInput": "<string>",
  "sessionId": "<string>",
  "sessionOwnerLabel": "<string>",
  "sessionAttributes": {}
}
'

import requests

url = "https://api.paygent.payman.ai/connect/interact/stream"

payload = {
    "userInput": "<string>",
    "sessionId": "<string>",
    "sessionOwnerLabel": "<string>",
    "sessionAttributes": {}
}
headers = {
    "x-paygent-connect-app-key": "<api-key>",
    "x-paygent-connect-grant": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-paygent-connect-app-key': '<api-key>',
    'x-paygent-connect-grant': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    userInput: '<string>',
    sessionId: '<string>',
    sessionOwnerLabel: '<string>',
    sessionAttributes: {}
  })
};

fetch('https://api.paygent.payman.ai/connect/interact/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.paygent.payman.ai/connect/interact/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([
    'userInput' => '<string>',
    'sessionId' => '<string>',
    'sessionOwnerLabel' => '<string>',
    'sessionAttributes' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-paygent-connect-app-key: <api-key>",
    "x-paygent-connect-grant: <api-key>"
  ],
]);

$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.paygent.payman.ai/connect/interact/stream"

	payload := strings.NewReader("{\n  \"userInput\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"sessionOwnerLabel\": \"<string>\",\n  \"sessionAttributes\": {}\n}")

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

	req.Header.Add("x-paygent-connect-app-key", "<api-key>")
	req.Header.Add("x-paygent-connect-grant", "<api-key>")
	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.paygent.payman.ai/connect/interact/stream")
  .header("x-paygent-connect-app-key", "<api-key>")
  .header("x-paygent-connect-grant", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userInput\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"sessionOwnerLabel\": \"<string>\",\n  \"sessionAttributes\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygent.payman.ai/connect/interact/stream")

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

request = Net::HTTP::Post.new(url)
request["x-paygent-connect-app-key"] = '<api-key>'
request["x-paygent-connect-grant"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userInput\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"sessionOwnerLabel\": \"<string>\",\n  \"sessionAttributes\": {}\n}"

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

"<string>"

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

Authorizations

x-paygent-connect-app-key

string

header

required

A Connect app key (pgc_app_…), identifying the registered third-party app. Always presented together with connectGrant — the pair is one credential, and either half alone is refused. Accepted on the /connect/* surface only.

x-paygent-connect-grant

string

header

required

A Connect grant token (pgc_grant_…): one user's consent for the presenting app to reach one deployment. Every failure mode — missing, malformed, revoked, expired, or paired with the wrong app key — answers the same 401 invalid_connect_credentials.

Body

application/json

userInput

string

required

Minimum string length: 1

sessionId

string | null

Reuse across turns to thread conversation history.

sessionOwnerLabel

string | null

Display name for the end user; defaults to the caller's email.

sessionAttributes

object | null

Extra per-call attributes merged into the ones derived from the stored configuration. Configuration wins on a key collision, so a caller cannot override a stored bank token from the request body.

Show child attributes

analysisMode

enum<string> | null

Available options:

fast,

deep

Response

The customer's agent's event stream

The response is of type string.

⌘I

Send a message to the granted deployment and stream the answer

curl --request POST \
  --url https://api.paygent.payman.ai/connect/interact/stream \
  --header 'Content-Type: application/json' \
  --header 'x-paygent-connect-app-key: <api-key>' \
  --header 'x-paygent-connect-grant: <api-key>' \
  --data '
{
  "userInput": "<string>",
  "sessionId": "<string>",
  "sessionOwnerLabel": "<string>",
  "sessionAttributes": {}
}
'

import requests

url = "https://api.paygent.payman.ai/connect/interact/stream"

payload = {
    "userInput": "<string>",
    "sessionId": "<string>",
    "sessionOwnerLabel": "<string>",
    "sessionAttributes": {}
}
headers = {
    "x-paygent-connect-app-key": "<api-key>",
    "x-paygent-connect-grant": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-paygent-connect-app-key': '<api-key>',
    'x-paygent-connect-grant': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    userInput: '<string>',
    sessionId: '<string>',
    sessionOwnerLabel: '<string>',
    sessionAttributes: {}
  })
};

fetch('https://api.paygent.payman.ai/connect/interact/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.paygent.payman.ai/connect/interact/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([
    'userInput' => '<string>',
    'sessionId' => '<string>',
    'sessionOwnerLabel' => '<string>',
    'sessionAttributes' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-paygent-connect-app-key: <api-key>",
    "x-paygent-connect-grant: <api-key>"
  ],
]);

$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.paygent.payman.ai/connect/interact/stream"

	payload := strings.NewReader("{\n  \"userInput\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"sessionOwnerLabel\": \"<string>\",\n  \"sessionAttributes\": {}\n}")

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

	req.Header.Add("x-paygent-connect-app-key", "<api-key>")
	req.Header.Add("x-paygent-connect-grant", "<api-key>")
	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.paygent.payman.ai/connect/interact/stream")
  .header("x-paygent-connect-app-key", "<api-key>")
  .header("x-paygent-connect-grant", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"userInput\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"sessionOwnerLabel\": \"<string>\",\n  \"sessionAttributes\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paygent.payman.ai/connect/interact/stream")

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

request = Net::HTTP::Post.new(url)
request["x-paygent-connect-app-key"] = '<api-key>'
request["x-paygent-connect-grant"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"userInput\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"sessionOwnerLabel\": \"<string>\",\n  \"sessionAttributes\": {}\n}"

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

"<string>"

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

{
  "category": "VALIDATION",
  "code": "agent_not_configured",
  "message": "Configure this agent before sending it messages.",
  "details": {}
}

Connect

Act

Approve

Tool

Send a message to the granted deployment and stream the answer

Authorizations

Body

Response