/interact

Initiate a real-time exchange with an Agent

POST /v1 /interact

This endpoint allows you to send messages to a Zams Agent and receive structured, model-generated responses — enabling dynamic, state-aware, and tool-augmented interactions. This is the primary interface for embedding agent conversations into products, workflows, or custom UIs.

Header

Key	Value
Authorization	YOUR_API_KEY

Parameters

Key	Type	Description
agent_id	String	Target Agent ID
exchange_id	String	Optional. ID to continue a conversation. Default is new
query	String	Natural language query

Request

import requests

url = "https://api.zams.com/v1/interact"

headers = {
    "Authorization": "ApiKey <your_api_key>",
    "Content-Type": "application/json"
}

payload = {
    "agent_id": "c7uuh82",
    "exchange_id": "new",
    "query": "What is the latest signed contract from last week named?",
}

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

print(response.json())

Response

200

A reply from the Agent along with an exchange ID to facilitate follow-up communication.

{
    "response": "Name of the contract is Class Fiction Frontier.",
    "exchange_id": "c7uuh82"
}

400

{
    "error": "Unauthorized"
}