Developer documentation
& API contracts.
Deterministic REST endpoints and typed Zod schemas for high-throughput automated workflows. Sub-350ms response budgets with ephemeral RAM memory guarantees.
Quickstart & API Keys
All requests to the NorAI API must be authenticated using an API bearer token in the HTTP request headers. Pass your key in the Authorization header.
Authorization: Bearer norai_live_sec_key Content-Type: application/json Accept: application/json
REST API Reference
Select an endpoint below to inspect the path, request parameters, and executable code snippets in cURL and TypeScript.
curl -X POST https://api.norai.in/v1/shortlist \
-H "Authorization: Bearer norai_live_sec_key" \
-H "Content-Type: multipart/form-data" \
-F "resume=@candidate_resume.pdf" \
-F "job_criteria='{\"title\": \"Sr Backend Engineer\", \"min_exp\": 4}'"3-Stage Execution Pipeline Trace
Inspect the deterministic flow of data through our multi-format ingestion, quantized inference core, and sub-second dispatch relay.
End-to-End Execution Flow
Multi-Format Ingestion
Zero-Egress Stream Parser
- —PDF / DOCX / TXT Parsing
- —Audio / Video Whisper Ingestion
- —Webhook & Telegram Listeners
Deterministic Neural Core
Quantized vLLM & Guardrails
- —FP8 / AWQ LoRA Inference
- —Strict Zod Schema Enforcement
- —Zero Hallucination Validation
Actionable Dispatch
Sub-Second Payload Relay
- —MCP Server Endpoint Response
- —Ephemeral RAM Flushed (0B Egress)
- —Immediate Webhook Callbacks
Typed Schemas & Protocols
Zero schema drift. Every pipeline in the NorAI ecosystem runs against strict, versioned Zod schemas before returning data to the caller.
import { z } from 'zod';
import { defineAgentPipeline } from '@norai/orchestrator-core';
// Candidate Scoring & Evaluation Contract
export const CandidateEvaluationSchema = z.object({
candidateId: z.string().uuid(),
matchScore: z.number().min(0).max(100),
verifiedSkills: z.array(z.string()).nonempty(),
missingRequirements: z.array(z.string()),
probingQuestions: z.array(z.string()).length(3),
executionLatencyMs: z.number().max(350),
dataResidency: z.literal('EPHEMERAL_RAM_FLUSHED'),
});
export const shortlisterAgent = defineAgentPipeline({
name: 'ResumeShortlisterEngine',
model: 'vllm-llama-3.3-70b-instruct-fp8',
outputSchema: CandidateEvaluationSchema,
maxRetries: 2,
timeoutMs: 800,
});Error Handling Matrix
All error responses return a standardized JSON envelope with an explicit error code and actionable diagnostic string.
Request payload failed strict Zod schema validation. Inspect details array for failed fields.
Missing or malformed Authorization header. Expected Bearer <api_key>.
Corrupt binary file or unextractable text stream. Ensure document complies with size limits (<25MB).
Tier concurrency threshold exceeded. Retry with exponential backoff.
Deterministic worker execution timed out (>800ms) or model container unreachable.