Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
call-token
Generate call token
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/call-token \
  --header 'Client-Token: <api-key>'
{
  "token": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This method generates an ephemeral token for call SDK authentication.
The token is temporary and valid for a single connection. If the application restarts, a new token must be generated. It must be called from the backend, never from the frontend, to prevent credential exposure.

​
SDK Integration

This endpoint is designed to be used with the official call SDK: https://www.npmjs.com/package/@z-api/call For a practical example of generating and using the token in a backend environment, see the “Node.js Backend Example” section in the SDK documentation.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Response

​
200

​
token
string
Ephemeral token for call SDK authentication
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.