Developer endpoints

We recommend using these developer endpoints to test your integration. The /developer/api-version endpoint will validate credentials (orgId and authKey), apiVersion, and server connectivity. The /developer/webhook endpoint will give you insight (status code and errors) about your webhook's response to our API. If your webhook returns a 200 status code, the request is logged as a success. It is important to validate that your webhook is configured to handle the model response as billing is based on the success of the model call, not the success of the webhook call.

Additionally, these developer endpoints offer a complimentary way to test your integration without incurring any costs. This mock RikAI2 model response is sent to your webhook, enabling you to verify compatibility.

Mocked RikAI2 model-response sent in webhook test:

{
    "pages": 1,
    "documentId": "placeholder",
    "questions": 1,
    "baseModel": "ocr2",
    "model": "Rikai2",
    "apiVersion": "2025-05-08",
    "settings": {"advancedVision": True},
    "statusId": "placeholder",
    "data": [
        {
            "answer": "placeholder",
            "confidence": 0.9,
            "context": "placeholder",
            "question": "placeholder",
            "translated": "placeholder",
        }
    ],
    "language": "FI",
    "id": "placeholder",
    "status": "SUCCESS",
}

This response is based on data generated from a RikAI2 request with default behavior (webhookSendFull: true). More information on how to configure your webhook can be found here.