Skip to main content

Botconfig API Documentation

GET: Retrieve Botconfig​

Description​

This route is used to retrieve a list of botconfigs for a specific project and optional search capabilities.

Method​

GET

Response​

  • Returns a JSON response with the list of botconfig or an error message.

Status Codes​

  • 200 OK: botconfig retrieved successfully.
  • 500 Internal Server Error: Error listing botconfig.

Throws​

  • An error if request validation or botconfig retrieval fails.

Example cURL​

curl --location 'https://app.ai12z.net/api/projects/{projectId}/botconfig' \
--header 'Authorization: Bearer <YOUR_KEY>' \

GET: Retrieve Botconfig by ID​

Description​

This route is used to retrieve details of a specific botconfig by its ID.

Method​

GET

URL Parameters​

  • id (string): The ID of the botconfig to retrieve.

Response​

  • Returns a JSON response with botconfig details such as id, name, description and configuration.

Status Codes​

  • 200 OK: botconfig retrieved successfully.
  • 500 Internal Server Error:Error retrieving the botconfig.

Throws​

  • An error if the botconfig is not found or any other error occurs.

Example cURL​

curl --location 'https://app.ai12z.net/api/projects/{projectId}/botconfig' \
--header 'Authorization: Bearer <YOUR_KEY>'

Last updated on