Ai Copilot

Category: Admin Base URL: /admin/ai-feedback Authentication: Required Routes: 3 routes documented

Overview#

This section documents 3 API routes for ai copilot.

⚠️ These endpoints operate on your live store. POST/PUT/DELETE operations here — including sync, push, resync, and cache operations — modify or delete production data, and some trigger downstream effects such as warehouse orders or customer emails. DELETE operations are generally irreversible. Verify IDs and parameters carefully before calling them from scripts.

Quick Reference#

GET Admin Ai-feedback#

Endpoint: GET /admin/ai-feedback Authentication: Admin (Required)

Description#

GET /admin/ai-feedback List AI feedback with optional filtering and pagination

Response#

Success:

{
  feedbacks,
  count,
  offset,
  limit,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/ai-feedback' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Ai-feedback#

Endpoint: POST /admin/ai-feedback Authentication: Admin (Required)

Description#

POST /admin/ai-feedback Create new AI feedback

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success (201):

{
  feedback,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/ai-feedback' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Ai-feedback :id#

Endpoint: GET /admin/ai-feedback/:id Authentication: Admin (Required)

Description#

GET /admin/ai-feedback/:id Get a specific AI feedback entry

URL Parameters#

Response#

Success:

{
  feedback,
}

Error (400):

{
  message,
}

Error (404):

{
  message,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/ai-feedback/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

POST Admin Ai-feedback :id#

Endpoint: POST /admin/ai-feedback/:id Authentication: Admin (Required)

Description#

POST /admin/ai-feedback/:id Update an AI feedback entry (typically for review purposes)

URL Parameters#

Request Body#

This route does not declare a validation schema, so the accepted fields are not derivable from the source. Check the handler before relying on a particular body.

Response#

Success:

{
  feedback,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
  error,
}

Example Request#

curl -X POST 'https://your-store.omnicart.cc/admin/ai-feedback/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

DELETE Admin Ai-feedback :id#

Endpoint: DELETE /admin/ai-feedback/:id Authentication: Admin (Required)

Description#

DELETE /admin/ai-feedback/:id Delete an AI feedback entry

URL Parameters#

Response#

Success (200):

{
  id,
  deleted,
}

Error (400):

{
  message,
}

Error (400):

{
  message,
  error,
}

Example Request#

curl -X DELETE 'https://your-store.omnicart.cc/admin/ai-feedback/:id' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'

GET Admin Ai-interactions#

Endpoint: GET /admin/ai-interactions Authentication: Admin (Required)

Description#

GET /admin/ai-interactions/stats Get AI usage statistics for analytics dashboard

Response#

Success:

{
  stats,
  recent_queries,
}

Error (500):

{
  message,
  error,
}

Example Request#

curl -X GET 'https://your-store.omnicart.cc/admin/ai-interactions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json'