Validate

POST 
/bv/aisk/v1/chatbots:validate

This API is designed to validate the security of the chatbot, including domain control, and daily limitation. The authorization header should be prompt token.

---

It'll return a 403/Forbidden and consider the following error reasons:

• With ERROR_REASON_DOMAIN_INVALID that means the domain is invalid or not allowed.

  Response examples

  \{
    "code": 7,
    "message": "domain not allowed: http://localhost",
    "details": [
      \{
        "@type": "type.googleapis.com/google.rpc.ErrorInfo",
        "reason": "ERROR_REASON_DOMAIN_INVALID",
        "domain": "bv.aisk.v1",
        "metadata": \{\}
      \}
    ]
  \}

---

It'll return a 429/Too Many Requests and consider the following error reasons:

• With ERROR_REASON_PROMPT_OUT_OF_QUOTA that means the daily quota is reached and will be reset at 00:00 in the organization timezone.

  Response examples

  \{
    "code": 8,
    "message": "out of quota",
    "details": [
      \{
        "@type": "type.googleapis.com/google.rpc.ErrorInfo",
        "reason": "ERROR_REASON_PROMPT_OUT_OF_QUOTA",
        "domain": "bv.aisk.v1",
        "metadata": \{
          "limit": "3000",
          "reset_at": "2024-01-06T00:00:00+09:00",
          "reset_in": "11h18m33.091627s",
          "reset_in_sec": "40713.091627"
        \}
      \}
    ]
  \}

Request

Responses

200

A successful response.

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

401

A unauthenticated response. The header authorization was missing or unidentified.

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

429

500

A server error response. There are more HTTP status code mappings listed on here.

default

An unexpected error response.