Get Agent Details

This section provides instructions on using the /agent/:agentId endpoint to retrieve the details of a particular agent.

Step 1: Prepare Your Request

• Endpoint: /agent

• Method: POST

• URL: https://api.talkstackai.com/agent

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

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

Step 2: Create the Request Body

• projectId: The id of the project in which the agent exists.

• agentId: The id of the agent whose details you want to fetch.

{
    "projectId": "XXXXXXXXXXXXXXXXXXXXXXXXX",
    "agentId": "ZZZZZZZZZZZZZZZZZZZZZZZZZZZ"
}

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 agent requested.

Success Response:

• Status Code: 200 OK

• Body: The response includes details like name, projectId, systemInstruction, and id.

{
    "name": "John",
    "projectId": "XXXXXXXXXXXXXXXXXXX"
    "id": "XXXXXXXXXXXXXXXXXXXXXXXX"
    "systemInstruction": "prompt given to bot"
}

Troubleshooting

• 400 Bad Request: If the projectId or agentId is missing in the request.

• 404 Not Found: If the agent is not found.

• 500 Internal Server Error: For errors in fetching the agent details.

Last updated 17 hours ago