Learn how to find important identifiers like agentId, publicId, workspaceId, and slug for API integration.
agentId
If you’d like to execute the Agent in preview mode, you will need to provide the ID of the building Agent available in the editor URL:
Sumar link a URL
publicId
For published Agent execution, you need to provide the public Agent ID available here:
workspaceId
In your workspace dashboard, head over to Settings > General > Workspace ID and copy the workspace ID.
slug
The slug is a URL-friendly part of your workspace name and it is also part of your agent URL. To find your slug, follow these steps:
If you enabled streaming, whenever an AI message should be streamed, you will receive the following JSON response:
The agent is ready to accept the message streaming. You now need to send the following query:
Where {sessionId}
should be replaced by the session ID you got from the start chat response.
This endpoint will send Server-Sent events with all the information to display the streamed message.
Once it is done, you can continue the flow by sending a continue chat request with the streamed message as the message content.