/api/v1/diagnostics/narrative

GET

/api/v1/diagnostics/narrative

curl --request GET \
  --url 'https://nbaproplab.com/api/v1/diagnostics/narrative?runTest=false' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• BearerJwt
• OpsToken
• X-API-Key

Parameters

Query Parameters

runTest

boolean

Responses

200

OK

object

apiKeyConfigured

required

boolean

apiKeyPreview

required

string

model

required

string

testResult

required

null | string

testTimeMs

required

null | integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

cacheEntries

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

cacheOldestMinutes

required

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

status

required

string

testNarrative

One of:

null

null

object

object

executiveSummary

required

string

conclusion

required

string

sections

required

Array<object>

object

narrative

required

string

whyItMatters

required

string

object

apiKeyConfigured

required

boolean

apiKeyPreview

required

string

model

required

string

testResult

required

null | string

testTimeMs

required

null | integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

cacheEntries

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

cacheOldestMinutes

required

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

status

required

string

testNarrative

One of:

null

null

object

object

executiveSummary

required

string

conclusion

required

string

sections

required

Array<object>

object

narrative

required

string

whyItMatters

required

string

Example ^generated

{
  "apiKeyConfigured": true,
  "apiKeyPreview": "example",
  "model": "example",
  "testResult": "example",
  "testTimeMs": 1,
  "cacheEntries": 1,
  "cacheOldestMinutes": 1,
  "status": "example",
  "testNarrative": {
    "executiveSummary": "example",
    "conclusion": "example",
    "sections": [
      {
        "narrative": "example",
        "whyItMatters": "example"
      }
    ]
  }
}

object

apiKeyConfigured

required

boolean

apiKeyPreview

required

string

model

required

string

testResult

required

null | string

testTimeMs

required

null | integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

cacheEntries

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

cacheOldestMinutes

required

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

status

required

string

testNarrative

One of:

null

null

object

object

executiveSummary

required

string

conclusion

required

string

sections

required

Array<object>

object

narrative

required

string

whyItMatters

required

string

Example ^generated

{
  "apiKeyConfigured": true,
  "apiKeyPreview": "example",
  "model": "example",
  "testResult": "example",
  "testTimeMs": 1,
  "cacheEntries": 1,
  "cacheOldestMinutes": 1,
  "status": "example",
  "testNarrative": {
    "executiveSummary": "example",
    "conclusion": "example",
    "sections": [
      {
        "narrative": "example",
        "whyItMatters": "example"
      }
    ]
  }
}

401

Authentication required.

Media type application/problem+json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Insufficient permissions or tier.

Media type application/problem+json

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}