Get Active Agent

This section provides instructions on using the /project/active-agent endpoint to get id of an active agent.

Active agents are set for a project. These are the default agents for a project.

Step1: Prepare Your Request

  • Endpoint: /project/active-agent

  • Method: POST

  • URL: https://api.talkstackai.com/project/active-agent

  • Headers: Include Content-Type: application/json.

  • Authorization: Bearer token or x-api-key in Headers

Step2: Create the Request Body

  • projectId: Id of the project.

{
    "projectId": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}

Step 3: Send the Request

Use your preferred HTTP client to send the POST request with the JSON body.

Step 4: Handle the request

The response will provide detailed information about the new project created.

Success Response:

  • Status Code: 200 OK

  • Body:

{
    "message": "added webhook url.",
    "status": "success",
    "active_agent": "xxxxxxxxxxxxxxxxxx"
}

Troubleshooting

  • 400 Bad Request: If the projectId and active_agent are not in the request body.

  • 401 Unauthorized: If the user is unauthorized or the token is missing.

  • 404 Not Found: If no active agent is found for the project

  • 500 Internal Server Error: For errors while getting active agent.

Last updated