Document
Get a Document
Overview
Document
AI Chat
AI Table
- POSTCreate an AI Table
- GETList AI Tables
- GETGet an AI Table
- POSTUpdate an AI Table
- DELDelete an AI Table
- POSTCreate an AI Table column
- GETList all columns in an AI Table
- GETGet an AI Table column
- POSTUpdate an AI Table column
- POSTRun AI on all cells in a column
- DELDelete an AI Table column
- GETList all cells in a row
- POSTRun AI on all cells in a row
- POSTCreate cells and run AI
- POSTCreate cell without AI
- POSTUpdate cell without AI
- GETList all cells in an AI Table
Document
Get a Document
Fetch detailed information on a single Document by its unique ID
GET
/
api
/
document
/
{document_id}
curl --request GET \
--url https://cite.petal.org/api/document/{document_id} \
--header 'Authorization: Bearer <token>'
{
"annotation_ids": [
123
],
"annotations": [
{
"comment_count": 123,
"created_at": "<string>",
"description": "<string>",
"document_id": 123,
"id": 123,
"is_hidden": true,
"modified_at": "<string>",
"modified_by": 123,
"type": "<string>",
"use_ocr": true,
"user_id": 123
}
],
"comments": [
{
"annotation_id": 123,
"content": "<string>",
"created_at": "<string>",
"id": 123,
"modified_at": "<string>",
"modified_by": 123,
"user": {
"id": 123,
"name": "<string>"
},
"user_id": 123
}
],
"created_at": "<string>",
"csl": {},
"doctype": "<string>",
"file_resource_size": 123,
"file_size": 123,
"filename": "<string>",
"id": 123,
"is_trash": true,
"keywords": [
"<any>"
],
"meta": {},
"modified_at": "<string>",
"modified_by": 123,
"organization_id": 123,
"pages": 123,
"ranking": 123,
"resource_size": 123,
"resource_stats": {
"file_list": "<any>",
"file_size": 123,
"file_size_by_mime_type": "<any>",
"file_size_by_res_type": "<any>"
},
"snippet": "<string>",
"span": [
123
],
"status": {},
"suggested_tags": [
{
"color": "<string>",
"document_count": 123,
"id": 123,
"name": "<string>",
"organization_id": 123
}
],
"tag_ids": [
123
],
"tasks": [
{
"args_json": "<string>",
"created_at": "<any>",
"function": "<string>",
"group_id": "<string>",
"id": "<string>",
"module": "<string>",
"nrequeue": 123,
"parent_id": 123,
"parent_table": "<string>",
"runtime": 123,
"status": "<string>",
"traceback": "<string>",
"updated_at": "<any>"
}
],
"ui": {},
"use_ocr": true,
"user": {
"id": 123,
"name": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The unique ID of the Document
Response
200
application/json
OK
The response is of type object
.
curl --request GET \
--url https://cite.petal.org/api/document/{document_id} \
--header 'Authorization: Bearer <token>'
{
"annotation_ids": [
123
],
"annotations": [
{
"comment_count": 123,
"created_at": "<string>",
"description": "<string>",
"document_id": 123,
"id": 123,
"is_hidden": true,
"modified_at": "<string>",
"modified_by": 123,
"type": "<string>",
"use_ocr": true,
"user_id": 123
}
],
"comments": [
{
"annotation_id": 123,
"content": "<string>",
"created_at": "<string>",
"id": 123,
"modified_at": "<string>",
"modified_by": 123,
"user": {
"id": 123,
"name": "<string>"
},
"user_id": 123
}
],
"created_at": "<string>",
"csl": {},
"doctype": "<string>",
"file_resource_size": 123,
"file_size": 123,
"filename": "<string>",
"id": 123,
"is_trash": true,
"keywords": [
"<any>"
],
"meta": {},
"modified_at": "<string>",
"modified_by": 123,
"organization_id": 123,
"pages": 123,
"ranking": 123,
"resource_size": 123,
"resource_stats": {
"file_list": "<any>",
"file_size": 123,
"file_size_by_mime_type": "<any>",
"file_size_by_res_type": "<any>"
},
"snippet": "<string>",
"span": [
123
],
"status": {},
"suggested_tags": [
{
"color": "<string>",
"document_count": 123,
"id": 123,
"name": "<string>",
"organization_id": 123
}
],
"tag_ids": [
123
],
"tasks": [
{
"args_json": "<string>",
"created_at": "<any>",
"function": "<string>",
"group_id": "<string>",
"id": "<string>",
"module": "<string>",
"nrequeue": 123,
"parent_id": 123,
"parent_table": "<string>",
"runtime": 123,
"status": "<string>",
"traceback": "<string>",
"updated_at": "<any>"
}
],
"ui": {},
"use_ocr": true,
"user": {
"id": 123,
"name": "<string>"
}
}