Service endpoints

Calling a service endpoints lets you:

Initiate a session*

Endpoint details

Description: Start a new conversation session with your AI agent.

URL: POST https://agents.gigaml.com/webhook/initiate-session

Response codes:

• 200 OK: Session initiated successfully or session already exists
• 401 Unauthorized: Invalid API key
• 500 Internal Server Error: Server error

Description: Start a new conversation session with your AI agent.

URL: POST https://agents.gigaml.com/webhook/initiate-session

Response codes:

• 200 OK: Session initiated successfully or session already exists
• 401 Unauthorized: Invalid API key
• 500 Internal Server Error: Server error

Parameter	Type	Required	Description
ticket_id	string	Yes	A unique identifier for this conversation session
agent_id	string	Yes	The ID of the agent to use for this conversation
initialization_values	object	No	Optional key-value pairs your agent needs to start the conversation

{
  "ticket_id": "unique-ticket-identifier",
  "agent_id": "your-agent-id",
  "initialization_values": {
    "customer_name": "John Doe",
    "customer_email": "[e-mail]"
  }
}

Receive a message*

Endpoint details

Description: Receive a user message from an active conversation session.

URL: POST https://agents.gigaml.com/webhook/receive-message

Response codes:

• 200 OK: Message queued successfully or message already processed
• 404 Not Found: Session not found
• 401 Unauthorized: Invalid API key
• 500 Internal Server Error: Server error

Description: Receive a user message from an active conversation session.

URL: POST https://agents.gigaml.com/webhook/receive-message

Response codes:

• 200 OK: Message queued successfully or message already processed
• 404 Not Found: Session not found
• 401 Unauthorized: Invalid API key
• 500 Internal Server Error: Server error

Parameter	Type	Required	Description
ticket_id	string	Yes	The identifier for the conversation session
message_id	string	Yes	A unique identifier for this message
message	object	Yes	The message object containing role, content, and timestamp

Message object:

Field	Type	Required	Description
role	Literal[“user”]	Yes	The role of the message sender
content	string or array	Yes	The message content (text or structured content)
timestamp	number	No	Unix timestamp in milliseconds

{
  "ticket_id": "unique-ticket-identifier",
  "message_id": "unique-message-identifier",
  "message": {
    "role": "user",
    "content": "User's message text",
    "timestamp": 1742268182058
  }
}

Close a session

Endpoint details

Description: End an existing conversation session. Inactive conversations end after 1 hour by default.

URL: POST https://agents.gigaml.com/webhook/close-session

Response codes:

• 200 OK: Session closed successfully
• 404 Not Found: Session not found
• 401 Unauthorized: Invalid API key
• 500 Internal Server Error: Server error

Description: End an existing conversation session. Inactive conversations end after 1 hour by default.

URL: POST https://agents.gigaml.com/webhook/close-session

Response codes:

• 200 OK: Session closed successfully
• 404 Not Found: Session not found
• 401 Unauthorized: Invalid API key
• 500 Internal Server Error: Server error

Parameter	Type	Required	Description
ticket_id	string	Yes	The identifier for the conversation session
reason	string	Yes	The reason for closing the session
status	string	Yes	Enum defining how the session was closed for logging

{
  "ticket_id": "unique-ticket-identifier",
  "reason": "user_request",
  "status": "COMPLETED"
}