Get New Access Token from Refresh Token

POST

ai_agent

refresh_token

curl --request POST \
  --url https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "user123",
  "chatbot_id": "8a1e3f18-991b-4a2e-9973-f53e7fc94ff1",
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
'

import requests

url = "https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token"

payload = {
    "user_id": "user123",
    "chatbot_id": "8a1e3f18-991b-4a2e-9973-f53e7fc94ff1",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    user_id: 'user123',
    chatbot_id: '8a1e3f18-991b-4a2e-9973-f53e7fc94ff1',
    refresh_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
  })
};

fetch('https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token', 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://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token",
  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([
    'user_id' => 'user123',
    'chatbot_id' => '8a1e3f18-991b-4a2e-9973-f53e7fc94ff1',
    'refresh_token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token"

	payload := strings.NewReader("{\n  \"user_id\": \"user123\",\n  \"chatbot_id\": \"8a1e3f18-991b-4a2e-9973-f53e7fc94ff1\",\n  \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}")

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

	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://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"user123\",\n  \"chatbot_id\": \"8a1e3f18-991b-4a2e-9973-f53e7fc94ff1\",\n  \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"user123\",\n  \"chatbot_id\": \"8a1e3f18-991b-4a2e-9973-f53e7fc94ff1\",\n  \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}"

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

{
  "data": {
    "access_token": "<string>",
    "expires_at": 1753454477000
  }
}

Generate a new short-lived access_token using a valid refresh_token previously issued.

⚠️ Important: This endpoint must be called from your server. Never expose refresh_token or any sensitive token logic to the frontend or the iframe.

When the access_token passed in the iframe query params expires, the Chatzy AI iframe will send a postMessage event to the parent window with following JSON payload:

{
    type: "[TOKEN_REFRESH]"
    reason: "TokenExpiredError"
}

Your client application (the host of the iframe) must listen for this postMessage event, and call this /ai_agent/refresh_token API from your server to get a new access_token using the stored refresh_token. Once you get the new token, respond back to the iframe with following JSON payload:

{
  "type": "[TOKEN_REFRESH_RESPONSE]",
  "access_token": "<NEW_ACCESS_TOKEN>"
}

The Chatzy AI iframe will update the token internally and continue to make secure API calls using the new token.

⚠️ Do not send refresh_token to the iframe or store it in localStorage/cookies on the client. Chatzy AI iframe only needs access_token to make authorized API calls.

Body

application/json

user_id

string

required

Client's customer ID

Example:

"user123"

chatbot_id

string<uuid>

required

Example:

"8a1e3f18-991b-4a2e-9973-f53e7fc94ff1"

refresh_token

string

required

Valid refresh token issued during initial access token generation

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Response

200 - application/json

New access token issued successfully

data

object

Show child attributes

Get Access Token

Get New Access Token from Refresh Token

curl --request POST \
  --url https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "user123",
  "chatbot_id": "8a1e3f18-991b-4a2e-9973-f53e7fc94ff1",
  "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
'

import requests

url = "https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token"

payload = {
    "user_id": "user123",
    "chatbot_id": "8a1e3f18-991b-4a2e-9973-f53e7fc94ff1",
    "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    user_id: 'user123',
    chatbot_id: '8a1e3f18-991b-4a2e-9973-f53e7fc94ff1',
    refresh_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
  })
};

fetch('https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token', 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://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token",
  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([
    'user_id' => 'user123',
    'chatbot_id' => '8a1e3f18-991b-4a2e-9973-f53e7fc94ff1',
    'refresh_token' => 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...'
  ]),
  CURLOPT_HTTPHEADER => [
    "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://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token"

	payload := strings.NewReader("{\n  \"user_id\": \"user123\",\n  \"chatbot_id\": \"8a1e3f18-991b-4a2e-9973-f53e7fc94ff1\",\n  \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}")

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

	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://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"user123\",\n  \"chatbot_id\": \"8a1e3f18-991b-4a2e-9973-f53e7fc94ff1\",\n  \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/ai_agent/refresh_token")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"user123\",\n  \"chatbot_id\": \"8a1e3f18-991b-4a2e-9973-f53e7fc94ff1\",\n  \"refresh_token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...\"\n}"

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

{
  "data": {
    "access_token": "<string>",
    "expires_at": 1753454477000
  }
}

Conversational AI Agent Interactions

Authentication

Contact Conversations

Authorized iframe Access

Get New Access Token from Refresh Token

Body

Response