--- updatedAt: 2026-07-31T18:03:06.000Z agentTools: projectIndex: https://docs.sensible.so/llms.txt --- # Get CSV extraction You can use this endpoint to get CSV files from documents, for example, from PDFs. In more detail, this endpoint converts your JSON document extraction to a comma-separated values. To compile multiple documents into one CSV file, specify the IDs of their recent extractions in the request separated by commas, for example, `/generate_csv/867514cc-fce7-40eb-8e9d-e6ec48cdac34,5093c65f-05bd-46a3-8df7-da3ed00f6d35`. For the best compiled spreadsheet results, configure your SenseML so that the documents output identically named fields. For more information about the conversion process, see [SenseML to spreadsheet reference](doc:excel-reference). For a list of document file types that Sensible can extract data from, see [Supported file types](doc:file-types). Call this endpoint after an extraction completes. For more information about checking extraction status, see the `GET /documents/{id}` endpoint. # OpenAPI definition ```json { "openapi": "3.0.3", "servers": [ { "url": "https://api.sensible.so/v0", "description": "Production server (uses live data)" } ], "info": { "title": "Extraction", "version": "0.0.0", "license": { "name": "Sensible API", "url": "https://www.TBD.org/licenses/LICENSE-2.0.html" }, "description": "Extract structured data from documents with the Sensible API." }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Get Excel from documents", "description": "Convert extracted document data to spreadsheet" } ], "paths": { "/generate_csv/{ids}": { "get": { "operationId": "get-csv-extraction", "summary": "Get CSV extraction", "description": "You can use this endpoint to get CSV files from documents, for example, from PDFs. In more detail, this endpoint converts your JSON document extraction to a comma-separated values.\nTo compile multiple documents into one CSV file, specify the IDs of their recent extractions in the request separated by commas, for example,\n`/generate_csv/867514cc-fce7-40eb-8e9d-e6ec48cdac34,5093c65f-05bd-46a3-8df7-da3ed00f6d35`.\nFor the best compiled spreadsheet results, configure your SenseML so that the documents output identically named fields.\nFor more information about the conversion process, see [SenseML to spreadsheet reference](https://docs.sensible.so/docs/excel-reference).\nFor a list of document file types that Sensible can extract data from, see [Supported file types](https://docs.sensible.so/docs/file-types).\nCall this endpoint after an extraction completes. For more information about checking extraction status,\nsee the `GET /documents/{id}` endpoint.\n", "parameters": [ { "$ref": "#/components/parameters/ids" } ], "tags": [ "Get Excel from documents" ], "responses": { "200": { "description": "Indicates the extraction successfully converted to an CSV file. This response contains the download URL for the CSV file. The link\nexpires after 15 minutes.\n", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "$ref": "#/components/schemas/GeneratedFileUrl" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "415": { "$ref": "#/components/responses/415" }, "500": { "$ref": "#/components/responses/500" } } } } }, "components": { "responses": { "400": { "description": "Bad Request. Sensible returns either a plain-text error message or a structured JSON error, depending on what caused the failure. For more information, see the two content types below.", "content": { "text/plain": { "schema": { "title": "Bad Request", "type": "string", "example": "Either a specific set of messages about fields in the request, or error messages like the following examples - To use the asynchronous flow you must have persistence enabled Specified document type does not exist Specified document type ${named type} does not exist No published configurations found for environment ${environment} Specified golden does not exist Must provide the Content-Type header Missing request body or body.document Could not determine the content type of the document Could not determine the content type of the document. Please check that the document was correctly encoded as Base64 This PDF is invalid. If you submitted this PDF using Base64 encoding, please check that the encoding is correct This PDF is password protected. Please resubmit with password protection disabled This PDF is empty This PDF exceeds the maximum dimensions for OCR of 17 x 17 inches This PDF exceeds the maximum size for OCR of 50MB No fingerprints match for this PDF and fingerprint_mode is set to strict Content type of ${found} does not match declared type of ${expected} The start date must be before the end date" } }, "application/json": { "schema": { "title": "Bad Request (structured)", "type": "object", "description": "Returned instead of plain text when the request fails path, query, or body validation (for example, a malformed id, an out-of-range limit, or an invalid field in a JSON body), and for the extract_from_url document-fetch failure. The shape of `context` varies by cause: for validation failures, it echoes the offending path and/or query values; for the extract_from_url failure, it's the extraction's current state.", "properties": { "message": { "type": "string", "description": "Human-readable summary of the error." }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Present when the request failed path, query, or body validation -- one message per failing field, in the form '/ '." }, "context": { "type": "object", "additionalProperties": true, "description": "Additional context about the failure. See the parent description for how this varies by cause." } }, "required": [ "message" ] }, "examples": { "validationFailure": { "summary": "A path parameter failed validation", "value": { "message": "This request contains errors", "context": { "path": "/documents/{id}" }, "errors": [ "path/id should be valid version 4 UUID" ] } }, "documentFetchFailure": { "summary": "extract_from_url could not download the document", "value": { "message": "Transferring the file failed with 'Response code 404 (Not Found)'", "context": { "id": "e75dd6ee-ef8f-4960-8be2-ba22f8c398e3", "created": "2026-07-17T14:39:49.084Z", "completed": "2026-07-17T14:39:49.330Z", "status": "FAILED", "type": "1040s", "environment": "production", "errors": [], "error": "Response code 404:\n404: Not Found", "actor": "legacy: Sensible" } } } } } } }, "401": { "description": "Not authorized", "content": { "text/plain": { "schema": { "title": "Unauthorized", "type": "string", "example": "Unauthorized" } } } }, "415": { "description": "Unsupported Media Type", "content": { "text/plain": { "schema": { "title": "Unsupported Media Type", "type": "string", "description": "Unsupported file type. See https://docs.sensible.so/docs/file-types." } } } }, "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "title": "Sensible encountered an unknown error", "type": "string", "example": "Sensible encountered an unknown error" } } } } }, "parameters": { "ids": { "name": "ids", "required": true, "in": "path", "style": "simple", "description": "Comma-delimited list of unique extraction IDs.", "schema": { "$ref": "#/components/schemas/ExtractionIds" } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Sensible uses API keys to authenticate requests. Keep your API keys secure and do not share them publicly accessible areas such as GitHub, client-side code, etc. Authentication to the API is performed via Bearer Authentication. Provide your API key as the bearer auth value." } }, "schemas": { "GeneratedFileUrl": { "type": "string", "format": "url", "description": "The download URL for the generated file. The link expires after 15 minutes.", "example": "https://sensible-so-document-type-bucket-dev-us-west-2.s3.us-west-2.amazonaws.com/sensible/fc3484c5-3f35-4129-bb29-0ad1291ee9f8/EXTRACTION/14d82783-c12b-4e70-b0ae-ca1ce35a9836.xlsx?REDACTED" }, "ExtractionIds": { "type": "array", "description": "Unique extraction IDs", "items": { "$ref": "#/components/schemas/ExtractionId" } }, "ExtractionId": { "type": "string", "format": "uuid", "description": "Unique ID for the extraction, used to retrieve the extraction", "example": "246a6f60-0e5b-11eb-b720-295a6fba723e" } } } } ```