Streaming text/event-stream or plain text response.
API Integration
Available Endpoints
Your organization's current service access is shown below.
Enterprise jobs are enabled for high-volume workflows managed through portal exports.
Test Your API Connection
Run a minimal authenticated HTTP call to verify your API key works before deeper integration.
Node.js Connection Test
Python Connection Test
HTTP Reference Snippets
Endpoint and headers update automatically based on selected endpoint and key.
curl
Python
JavaScript
Endpoint Sandbox
Test authenticated endpoints in real-time with quick templates and custom requests. Inspect JSON responses and copy code snippets.
Quick Templates
Pre-configured requests for common tasks. Select one to load its endpoint, query, and parameters automatically.
Available presets: Search API Smoke Test Β· RAG Retrieval (enterprise retrieval eval) Β· Billing Snapshot Β· Recent Audit Events Β· Webhook Delivery Health
Build Your Query
Manually construct a request or modify a loaded template.
Response
Service: -Status: -Latency: -Updated: -
Ready
Run a request to inspect the response JSON...
Copy this request as:
Troubleshooting Assistant
No issues detected.
Audit Tools
Trace key events and access decisions with filterable audit logs.
When
Type
Status
Actor
Target
Details
Support
Open a ticket and keep the conversation with Timpi support in one place.
Your Tickets
Select a ticket to view the conversation.
Help & Guide
Everything you need to get started and make the most of the developer portal.
Quick Start β three steps to your first query
Create an API key β go to API Keys, click Create New Key, pick your service mode, and copy the key that appears. Store it securely; it is shown only once.
Run your first search β use Query Console to run a standard search, then switch to bulk search if your subscription includes it.
Check usage & cost β visit Billing to see your live request counts, cost breakdown by key and by owner, and export a CSV for accounting.
The Overview section is your operational dashboard. It shows:
Usage metrics β total requests, errors, and a recent activity sparkline at the top of the page.
Key Ownership card β active keys, unassigned keys, and the top owner by request volume.
Cost Attribution card β attributed vs. unattributed spend and the highest-cost key.
Webhook Health card β active endpoints, recent success rate, and last failure timestamp.
Security Alerts card β keys expiring soon, open IP/origin policies, and denied audit events in the last 7 days.
Each card contains Go there links that jump directly to the relevant section.
Webhooks push real-time event notifications to your own HTTPS endpoint.
Register endpoint β provide your HTTPS URL, a shared secret for HMAC verification, and choose which event types to subscribe to (search, key.created, key.revoked, etc.).
Delivery log β see the HTTP status of every delivery attempt and the response body.
Retry β manually re-trigger a failed delivery from the log table.
HMAC verification β each delivery includes an X-Webhook-Signature header. Verify it with your secret using SHA-256 HMAC to confirm authenticity.
Each API key carries a set of allowed actions: search (query the index). A key without the matching scope receives a 403 Forbidden response.
Key Policy
Policies add additional restrictions on top of scopes β an expiry date, an IP allowlist, and/or an origin allowlist. A request is rejected if it violates any active policy constraint.
Key Rotation
Rotation generates a new key value for an existing key record. An optional overlap window (in minutes) keeps the old value active so existing callers can update without downtime.
Cost Attribution
Every key records which portal user created it (owner). Billing rolls up request counts and cost per owner, enabling team-level spend tracking even when multiple keys are shared.
HMAC Signatures
Webhook deliveries are signed with HMAC-SHA256 using the endpoint's secret. Compute HMAC-SHA256(secret, rawBody) and compare to the X-Webhook-Signature header to confirm the payload is genuine.
Session Tokens
Portal login issues a signed, time-limited session token stored in localStorage. Tokens are validated server-side on every authenticated request; an invalid or expired token redirects to the login screen.
The portal has three roles. The role is set at invite time and can be changed by any Admin.
Capability
Admin
Developer
Billing
Create / revoke / rotate own keys
β
β
View all keys & usage
β
Set key policies
β
β
Use Query Console
β
β
View API Integration
β
β
β
View Billing (own keys)
β
β
β
Export billing CSV
β
β
Manage Webhooks
β
β
View Audit Logs
β
Invite / remove team members
β
Change team member roles
β
Code
Meaning
Resolution
401 Unauthorized
Missing or invalid API key in the request header.
Refresh your key from API Keys and re-run the request through Dev Portal tools.
403 Forbidden
Key is valid but lacks the required scope, or a policy constraint (IP, origin, expiry) rejected the request.