v1

latestOpenAPI 3.1.02026-08-06192355.6 KB

Documents

List Document

get/api/v1/document

Headers

CodeGPT-Org-Idstring

Organization ID that agents and documents belong to.

Response

Successful Response

idstring

Document id

created_atstring date-time

Date when the document was created

file_idstring

File id

user_idstring

User id

namestring

Name of the document

org_idstring

ID of the Organization the document belongs to

file_type'txt'

Type of the file

tokensinteger

Number of tokens in the document

chunk_countinteger

Number of chunks in the document

Example response

[
  {
    "id": "0000-0000-0000-0000",
    "created_at": "2023-01-01T12:00:00.000Z",
    "file_id": "0000-0000-0000-0000",
    "user_id": "0000-0000-0000-0000",
    "name": "La metamorfosis",
    "org_id": "0000-0000-0000-0000",
    "file_type": "txt",
    "metadata": {
      "title": "La metamorfosis",
      "description": "La metamorfosis es una novela escrita por Franz Kafka y publicada en 1915.",
      "summary": "Cuenta la historia de Gregorio Samsa, un comerciante de telas que vive con su familia a la que él mantiene con su sueldo, quien un día amanece convertido en un insecto.",
      "keywords": "metamorfosis, insecto",
      "language": "es"
    },
    "tokens": 1000,
    "chunk_count": 1
  }
]