> For the complete documentation index, see [llms.txt](https://docs.uptiq.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uptiq.ai/document-ai/developer-documentation/generation-1/get-document-generation-details.md). # Get document generation details ```json {"openapi":"3.1.0","info":{"title":"Document AI API","version":"1.0.0"},"tags":[{"name":"Generation"}],"servers":[{"description":"UAT","url":"https://api-docai-uat.uptiq.ai"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"X-Api-Key","type":"apiKey"}},"schemas":{"GetGenerationResponse.c36812a":{"properties":{"data":{"anyOf":[{},{"type":"null"}],"default":null,"title":"Data"},"generation":{"anyOf":[{"$ref":"#/components/schemas/GetGenerationResponse.c36812a.GetGenerationResponseObject"},{"type":"null"}],"description":"Generation response"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"title":"Message"},"status":{"default":"success","enum":["success","error"],"title":"Status","type":"string"}},"required":["generation"],"title":"GetGenerationResponse","type":"object"},"GetGenerationResponse.c36812a.GetGenerationResponseObject":{"properties":{"_id":{"description":"Generation ID","title":"Id","type":"string"},"accountId":{"description":"Account ID","title":"Accountid","type":"string"},"createdAt":{"description":"Creation timestamp","title":"Createdat","type":"string"},"data":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"default":null,"description":"Section data array","title":"Data"},"documentType":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Document type (legacy field)","title":"Documenttype"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Error message if failed","title":"Error"},"errorDetails":{"anyOf":[{"$ref":"#/components/schemas/GetGenerationResponse.c36812a.ErrorDetails"},{"type":"null"}],"default":null,"description":"Structured error details if failed"},"failedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Failure timestamp (if failed)","title":"Failedat"},"format":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Document format (docx)","title":"Format"},"jobEndTime":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Job end time","title":"Jobendtime"},"jobStartTime":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Job start time","title":"Jobstarttime"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Metadata","title":"Metadata"},"processedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Processing timestamp (success)","title":"Processedat"},"processingAttempts":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":0,"description":"Number of processing attempts (0-3)","title":"Processingattempts"},"requestId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Request tracking ID","title":"Requestid"},"status":{"description":"Status (Pending|Processing|Processed|Failed)","title":"Status","type":"string"},"storageInfo":{"anyOf":[{"$ref":"#/components/schemas/GetGenerationResponse.c36812a.StorageInfo"},{"type":"null"}],"default":null,"description":"Storage information (if processed)"},"style":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"description":"Style configuration","title":"Style"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Update timestamp","title":"Updatedat"},"webhookUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Webhook URL if configured","title":"Webhookurl"}},"required":["_id","requestId","accountId","format","status","createdAt","updatedAt"],"title":"GetGenerationResponseObject","type":"object"},"GetGenerationResponse.c36812a.ErrorDetails":{"description":"Error details for failed generations","properties":{"message":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Additional error message","title":"Message"},"stack":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null,"description":"Stack trace if available","title":"Stack"},"statusCode":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"HTTP status code if applicable","title":"Statuscode"},"type":{"description":"Error type (ValidationError, LLMError, StorageError, etc.)","title":"Type","type":"string"}},"required":["type"],"title":"ErrorDetails","type":"object"},"GetGenerationResponse.c36812a.StorageInfo":{"description":"Storage metadata for processed documents","properties":{"container":{"description":"Storage container/bucket name","title":"Container","type":"string"},"contentType":{"default":"application/vnd.openxmlformats-officedocument.wordprocessingml.document","description":"MIME type","title":"Contenttype","type":"string"},"key":{"description":"Object key/path in storage","title":"Key","type":"string"},"provider":{"description":"Storage provider (AzureBlobStorage, S3, GCS)","title":"Provider","type":"string"},"size":{"description":"File size in bytes","title":"Size","type":"integer"},"uploadedAt":{"description":"Upload timestamp","title":"Uploadedat","type":"string"}},"required":["provider","container","key","size","uploadedAt"],"title":"StorageInfo","type":"object"},"ValidationError.6a07bef":{"description":"Model of a validation error response.","items":{"$ref":"#/components/schemas/ValidationError.6a07bef.ValidationErrorElement"},"title":"ValidationError","type":"array"},"ValidationError.6a07bef.ValidationErrorElement":{"description":"Model of a validation error response element.","properties":{"ctx":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"default":null,"title":"Error context"},"loc":{"items":{"type":"string"},"title":"Missing field name","type":"array"},"msg":{"title":"Error message","type":"string"},"type":{"title":"Error type","type":"string"}},"required":["loc","msg","type"],"title":"ValidationErrorElement","type":"object"}}},"paths":{"/generate/{_id}":{"get":{"description":"","operationId":"get__generate_{_id}","parameters":[{"description":"","in":"path","name":"_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGenerationResponse.c36812a"}}},"description":"OK"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationError.6a07bef"}}},"description":"Bad Request"},"401":{"description":"Authentication required — the `X-Api-Key` header is missing or invalid."},"500":{"description":"Returned for **every** input, with `\"Invalid generation ID format\"` — including the exact `generationId` returned by `POST /generate`. Verified against the issued UUID, a hyphen-stripped form, a prefixed form and a nil UUID. This endpoint is currently unusable; collect generated documents via `POST /generate/sync` or a completion webhook. Known defect — see the API Reference."}},"summary":"Get document generation details","tags":["Generation"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.uptiq.ai/document-ai/developer-documentation/generation-1/get-document-generation-details.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.