Skip to main content

Copilot QA Tests API Documentation

GET: Retrieve Copilot QA Tests​

Description​

This route is used to retrieve a list of Copilot QA Tests interface is designed to streamline the process of validating the functionality and performance of copilot agents.

Method​

GET

Query Parameters​

  • sort (string): The field by which to sort the Copilot QA Tests.
  • page (number): The page number of the results.
  • limit (number): The number of items per page.
  • searchTerm (string): Optional search term to filter Copilot QA Tests.

Response​

  • Returns a JSON response with the list of Copilot QA Tests or an error message.

Status Codes​

  • 200 OK: Copilot QA Tests retrieved successfully.
  • 500 Internal Server Error: Error listing Copilot QA Tests.

Throws​

  • An error if request validation or Copilot qa tests retrieval fails.

Example cURL​

curl --location 'https://app.ai12z.net/api/projects/{projectId}/qa' \
--header 'Authorization: Bearer <YOUR_KEY>'
--data-urlencode 'sort=name' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=10'

GET: Retrieve Copilot QA Tests by ID​

Description​

This route is used to retrieve details of a specific Copilot QA Tests by its ID.

Method​

GET

URL Parameters​

  • id (string): The ID of the Copilot QA Tests to retrieve.

Response​

  • Returns a JSON response with Copilot QA Tests details such as id, name and instructions.

Status Codes​

  • 200 OK: Copilot QA Tests retrieved successfully.
  • 500 Internal Server Error: Error retrieving the Copilot QA Tests.

Throws​

  • An error if the Copilot QA Tests is not found or any other error occurs.

Example cURL​

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

POST: Create a Copilot QA Tests​

Description​

This route is used to create a new Copilot QA Tests for a project.

Method​

POST

Request Body​

Example request body:

{
  "name": "QA Test Name",
  "instructions": "instructions"
}

Response​

  • Returns the newly created Copilot QA Tests.

Status Codes​

  • 200 OK: Copilot QA Tests created successfully.
  • 500 Internal Server Error: Error creating the Copilot QA Tests.

Throws​

  • An error if request validation or Copilot QA Tests creation fails.

Example cURL​

curl --location 'https://app.ai12z.net/api/projects/{projectId}/qa' \
--header 'Authorization: Bearer <YOUR_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
            "name":"QA Test Name",
            "instructions":"instructions"
}'

PUT: Update a Copilot QA Tests​

Description​

This route is used to update an existing Copilot QA Tests.

Method​

PUT

Request Body​

Example request body:

{ "name": "QA Test Name", "instructions": "instructions" }

Response​

  • Returns the updated Copilot QA Tests.

Status Codes​

  • 200 OK: Copilot QA Tests updated successfully.
  • 500 Internal Server Error: Error updating the Copilot QA Tests.

Throws​

  • An error if request validation or Copilot QA Tests update fails.

Example cURL​

curl --location --request PUT 'https://app.ai12z.net/api/projects/{projectId}/qa' \
--header 'Authorization: Bearer <YOUR_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
            "id":"Copilot ID",
            "name":"QA Test Name",
            "instructions":"instructions"
}'

DELETE: Delete a Copilot QA Tests​

Description​

This route is used to delete an existing Copilot QA Tests.

Method​

DELETE

Request Body​

Example request body:

{
  "id": "Copilot ID"
}

Response​

  • Returns a confirmation message indicating successful deletion.

Status Codes​

  • 200 OK: Copilot QA Tests deleted successfully.
  • 500 Internal Server Error: Error deleting the Copilot QA Tests.

Throws​

  • An error if request validation or Copilot QA Tests deletion fails.

Example cURL​

curl --location --request DELETE 'https://app.ai12z.net/api/projects/{projectId}/qa' \
--header 'Authorization: Bearer <YOUR_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "Copilot ID"
}'