Get one AI audit record

GET

/api/v3/organizations/{organisation}/ai/audit/record

const url = 'https://dashboard.quantcdn.io/api/v3/organizations/example/ai/audit/record?key=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dashboard.quantcdn.io/api/v3/organizations/example/ai/audit/record?key=example' \
  --header 'Authorization: Bearer <token>'

One record by key (a key from aiAuditRecordsList). A key of another organisation is 400. prompt and response are returned only when the record stores them. The read is recorded in the audit log first (503 when it cannot be). Needs view_ai_audit and, for a scoped token, ai:audit:read.

Authorizations

BearerAuth
ai:audit:read

Parameters

Path Parameters

organisation

required

string

The organisation machine name

Query Parameters

key

required

string

<= 1024 characters

Responses

200

The record.

application/json

object

key

required

string

date

required

string format: date

summary

required

Normalised fields of any record type. A field with an unexpected type is left out.

object

message

required

Error message

string

error

required

Error flag

boolean

recordType

required

Inference for a record without recordType; tool_denied, tool_proposal, tool_decision, tool_outcome, slack_bot_api, audit_access, …; unknown for an unreadable object

string

timestamp

string format: date-time

userId

string

tokenId

string

modelId

string

interface

string

tools

required

Array<string>

decision

string

outcome

string

record

required

object

key

additional properties

any

Example

{
  "summary": {
    "message": "The requested resource was not found",
    "error": true
  }
}

400

The key is not a record key of this organisation.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

error

required

string

code

string

retryable

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true,
  "code": "UNAVAILABLE"
}

403

PERMISSION_DENIED or SCOPE_REQUIRED

404

Not found, or archived (older than 365 days).

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

error

required

string

code

string

retryable

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true,
  "code": "UNAVAILABLE"
}

503

UNAVAILABLE: the read could not be recorded, so it was not made.

application/json

object

message

required

Error message

string

error

required

Error flag

boolean

error

required

string

code

string

retryable

boolean

Example

{
  "message": "The requested resource was not found",
  "error": true,
  "code": "UNAVAILABLE"
}