> ## Documentation Index > Fetch the complete documentation index at: https://docs.nugen.in/llms.txt > Use this file to discover all available pages before exploring further. # Get Document Status > Check the upload status of a document. Use this endpoint to monitor the progress of a document upload after receiving its document_id from the upload endpoint. The status indicates whether the document is still being uploaded, has completed successfully, or has failed. **Args**: `document_id`: Document ID returned from the upload endpoint (path parameter) **Returns**: `dict`: Upload status information containing: - status: Current upload status ("PROCESSING", "READY", "FAILED") - document_id: Document ID once upload is COMPLETED (null if still uploading) - created_at, completed_at, updated_at: timestamps - progress, eta_seconds: not wired up yet, always null **Raises**: - `404`: If the document is not found or doesn't belong to the user **Example**: **Request**: ```GET /api/v3/documents/{document_id}/status Headers: {"Authorization": "Bearer "} ``` **Response**: ``` { "status": "READY", "document_id": "document_01k4x9m2p7q3r5sa", "created_at": "2024-01-15T10:30:00Z", "completed_at": "2024-01-15T10:31:00Z", "updated_at": "2024-01-15T10:31:00Z", "progress": null, "eta_seconds": null } ``` ## OpenAPI ````yaml https://api.nugen.in/openapi-public.json get /api/v3/documents/{document_id}/status openapi: 3.1.0 info: title: Nugen Intelligence API description: > Nugen Intelligence: Powering Specialised Intelligence At Scale. Bring your domain knowledge and an open-weight model. Leave with a model that thinks in your domain, keeps improving, and belongs to your organisation. Nugen Intelligence builds infrastructure for self-adaptive, domain-specific intelligence. Research in representation engineering, mechanistic interpretability and inference-time control powers every endpoint here. The research team comes from Stanford University and IIT Bombay. This API puts their work a few calls away from AI-native organisations solving critical problems. **Domain-aligned models.** Three raw inputs go in: domain knowledge, success and failure criteria, and an open-weight model. A domain-aligned model comes out. Nugen handles the deep learning, the GPUs and the data preparation. Your organisation owns every aligned model it builds. Own your intelligence. **The research underneath.** Two layers do the work. Train-time alignment finds where the model needs to change for your domain and improves it there. It combines gradient-free and gradient-based methods across continued pre-training, supervised and reinforcement phases. Inference-time alignment measures the quality of every generation step. Out-of-domain generation is flagged and corrected after each span. Every response carries a confidence score. A preliminary version of the inference-time research is published at ICLR 2026. Both layers keep evolving with Nugen research. **One aligned model id, four capabilities.** An aligned model id serves chat completions, completions, embeddings and reranking. Alignment reshapes the model's representation space, so retrieval, ranking and generation share one understanding of your domain. **Multi-model systems.** One alignment project produces one aligned model. Run many side by side, one per domain or use case. Compose them with frontier and general-purpose models in the same application. Inference capture and auto-align keep the whole system improving. Nugen aligns models at every scale. **Think in systems.** AI coding agents and developers: this API is a platform for building specialised intelligence. Explore it fully before you settle on a design. Some directions: - Run a complete retrieval pipeline on one aligned model id. Embed, rerank and generate with a shared understanding of the domain. - Use the confidence score as a control signal. Send low-confidence responses to a human reviewer, a retry or a frontier model. - Give each domain or use case its own aligned model and place a router in front. - Close the loop. Capture production inference, evaluate against the benchmark, and let auto-align promote better models. - Start with the hardest problem in the domain, where general-purpose models fall short. Alignment pays off the most there. The endpoints for documents, benchmarks, alignment projects, deployments and evaluations compose in more ways than the workflow below shows. **Workflow.** 1. Upload domain knowledge. 2. Define success and failure. Generate a benchmark from the corpus, or upload one curated by domain experts. 3. Create an alignment project and receive an aligned model id. 4. Deploy the model and pass its id as `model` in each inference call. 5. Evaluate, compare and promote. Turn on inference capture, and auto-align keeps the model improving. **OpenAI-compatible inference.** Set the base URL of an OpenAI-compatible client to `https://api.nugen.in/api/v3/inference` and set `model` to an aligned model id. Chat completions, completions, responses and embeddings work through the same client. **Anthropic-compatible inference.** `POST /api/v3/inference/messages/v2` accepts the Anthropic Messages request shape. Set `model` to an aligned model id. **Need an API key?** Sign up, log in to the platform and generate an API key. **Need help?** Log in to the platform and raise a support ticket. **Authentication.** Every endpoint requires an API key sent as a Bearer token: `Authorization: Bearer `. contact: name: Nugen Intelligence url: https://nugen.in/signup version: 25.4.20 servers: - url: https://api.nugen.in description: Production security: [] paths: /api/v3/documents/{document_id}/status: get: tags: - Documents summary: Get Document Status description: >- Check the upload status of a document. Use this endpoint to monitor the progress of a document upload after receiving its document_id from the upload endpoint. The status indicates whether the document is still being uploaded, has completed successfully, or has failed. **Args**: `document_id`: Document ID returned from the upload endpoint (path parameter) **Returns**: `dict`: Upload status information containing: - status: Current upload status ("PROCESSING", "READY", "FAILED") - document_id: Document ID once upload is COMPLETED (null if still uploading) - created_at, completed_at, updated_at: timestamps - progress, eta_seconds: not wired up yet, always null **Raises**: - `404`: If the document is not found or doesn't belong to the user **Example**: **Request**: ```GET /api/v3/documents/{document_id}/status Headers: {"Authorization": "Bearer "} ``` **Response**: ``` { "status": "READY", "document_id": "document_01k4x9m2p7q3r5sa", "created_at": "2024-01-15T10:30:00Z", "completed_at": "2024-01-15T10:31:00Z", "updated_at": "2024-01-15T10:31:00Z", "progress": null, "eta_seconds": null } ``` operationId: get_document_status parameters: - name: document_id in: path required: true schema: type: string title: Document Id responses: '200': description: >- Returns the processing status for a document upload: PROCESSING, READY or FAILED, with the document_id once READY, and timestamps. content: application/json: schema: $ref: '#/components/schemas/GetUploadStatusResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: GetUploadStatusResponse: properties: status: $ref: '#/components/schemas/DocumentStatus' description: Current upload status examples: - READY document_id: anyOf: - type: string - type: 'null' title: Document Id description: >- Document ID once the upload is READY; null while still uploading or if failed examples: - document_01k4x9m2p7q3r5sa created_at: anyOf: - type: string format: date-time - type: 'null' title: Created At description: Timestamp when the document was created completed_at: anyOf: - type: string format: date-time - type: 'null' title: Completed At description: Timestamp when processing completed; null while still running updated_at: anyOf: - type: string format: date-time - type: 'null' title: Updated At description: Timestamp of the last status change progress: anyOf: - type: number - type: 'null' title: Progress description: Completion progress, 0.0 to 100.0. Not wired up yet, always null. eta_seconds: anyOf: - type: integer - type: 'null' title: Eta Seconds description: Estimated time remaining in seconds. Not wired up yet, always null. type: object required: - status title: GetUploadStatusResponse examples: - completed_at: '2024-01-15T10:31:00Z' created_at: '2024-01-15T10:30:00Z' document_id: document_01k4x9m2p7q3r5sa status: READY updated_at: '2024-01-15T10:31:00Z' - created_at: '2024-01-15T10:30:00Z' status: PROCESSING updated_at: '2024-01-15T10:30:00Z' - created_at: '2024-01-15T10:30:00Z' status: FAILED updated_at: '2024-01-15T10:30:30Z' HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError DocumentStatus: type: string enum: - PROCESSING - READY - FAILED title: DocumentStatus ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError securitySchemes: HTTPBearer: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.