Log Corpus Item Referral & Redirect | Apologist AI

Records a referral for a corpus item and, when a url is supplied, issues a 302 redirect to it. Without a url, responds with a success message. Requires either the search API entitlement or a same-origin request.

Authentication

x-api-keystring

API key for authentication

AuthorizationBearer

Bearer token authentication

Path parameters

modelstringRequired

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

idstringRequired

The numeric ID of the corpus item

Query parameters

prompt_idstringRequired

user_idstringOptional

urlstringOptional

URL-encoded destination to redirect to after logging the referral.

Response

Referral successfully logged

successboolean

messagestring

Errors

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

1	import { ApologistAgentClient } from "apologist";
2
3	async function main() {
4	const client = new ApologistAgentClient({
5	apiKey: "YOUR_API_KEY_HERE",
6	});
7	await client.corpus.logCorpusReferralRedirect("id", "model", {
8	promptId: "prompt_id",
9	});
10	}
11	main();