Log Corpus Item Referral

View as Markdown
Records that a user was referred to a corpus item

Authentication

x-api-keystring
API key for authentication
OR
AuthorizationBearer
Bearer token authentication

Path parameters

modelstringRequired

The model type (e.g., ‘source’)

idstringRequired
The ID of the corpus item

Request

This endpoint expects an object.
prompt_idstringRequired
user_idstring or nullOptional1-100 characters

Response

Referral successfully logged
successboolean
messagestring

Errors

403
Forbidden Error
422
Unprocessable Entity Error
503
Service Unavailable Error