Files

Retrieve a single file by ID

GET
/api/v1/files/{id}

Retrieve a single file by ID.

Authorization

bearerAuth
AuthorizationBearer <token>

Console session token (Authorization: Bearer <session>) or product API key (Authorization: Bearer <api-key> or x-api-key). Session tokens are validated via Better Auth get-session; API keys against the shared database.

In: header

Path Parameters

id*Id

A unique integer value identifying this Document.

Query Parameters

include_content?boolean|null

Header Parameters

authorization?string|null
x-api-key?string|null

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/files/0"
{  "id": 0,  "filename": "string",  "workspace": {    "id": 0,    "name": "string",    "workspace_type": "string"  },  "summaries": [    {      "language": "en",      "summary": "string"    }  ],  "title": "string",  "extension": "string",  "status": "pending",  "status_vision": "pending",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "total_pages": 0,  "size": 0,  "tags": [    {      "id": 0,      "name": "string",      "auto_assigned": true    }  ],  "created_by": {    "id": 0,    "first_name": "string",    "last_name": "string",    "username": "string"  },  "upload_session_uuid": "77d43759-6ed9-4819-a910-9d5d508d4a5c",  "signature": "string",  "pages": [    {      "index": 0,      "markdown": "string"    }  ],  "status_detail": "string",  "parser": "string",  "external_metadata": {    "external_id": "string",    "doc_type": "string",    "additional_metadata": null  }}