# Documents resources

## Documents

> return all documents

```json
{"openapi":"3.1.0","info":{"title":"Helvia.ai Document Segmenter","version":"1.1.0"},"tags":[{"name":"Documents resources"}],"security":[{"JWTBearer":[]}],"components":{"securitySchemes":{"JWTBearer":{"type":"http","scheme":"bearer"}},"schemas":{"DocumentsReplySchema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DocumentSchema"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"DocumentsReplySchema"},"DocumentSchema":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/DocumentStatus"},"created":{"type":"string","format":"date-time","title":"Created"},"updated":{"type":"string","format":"date-time","title":"Updated"},"filename":{"type":"string","title":"Filename"},"filesize":{"type":"integer","title":"Filesize"},"mimetype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mimetype"}},"type":"object","required":["id","status","created","updated","filename","filesize","mimetype"],"title":"DocumentSchema"},"DocumentStatus":{"type":"string","enum":["PROCESSED","NEW","CANCELED"],"title":"DocumentStatus"}}},"paths":{"/documents/":{"get":{"tags":["Documents resources"],"summary":"Documents","description":"return all documents","operationId":"documents_documents__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentsReplySchema"}}}},"404":{"description":"Not found"}}}}}}
```

## Get Document

> return a single document

```json
{"openapi":"3.1.0","info":{"title":"Helvia.ai Document Segmenter","version":"1.1.0"},"tags":[{"name":"Documents resources"}],"security":[{"JWTBearer":[]}],"components":{"securitySchemes":{"JWTBearer":{"type":"http","scheme":"bearer"}},"schemas":{"DocumentSchema":{"properties":{"id":{"type":"string","title":"Id"},"status":{"$ref":"#/components/schemas/DocumentStatus"},"created":{"type":"string","format":"date-time","title":"Created"},"updated":{"type":"string","format":"date-time","title":"Updated"},"filename":{"type":"string","title":"Filename"},"filesize":{"type":"integer","title":"Filesize"},"mimetype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mimetype"}},"type":"object","required":["id","status","created","updated","filename","filesize","mimetype"],"title":"DocumentSchema"},"DocumentStatus":{"type":"string","enum":["PROCESSED","NEW","CANCELED"],"title":"DocumentStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/documents/{documentid}":{"get":{"tags":["Documents resources"],"summary":"Get Document","description":"return a single document","operationId":"get_document_documents__documentid__get","parameters":[{"name":"documentid","in":"path","required":true,"schema":{"type":"string","title":"Documentid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentSchema"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Document Segments

> return all document segments

```json
{"openapi":"3.1.0","info":{"title":"Helvia.ai Document Segmenter","version":"1.1.0"},"tags":[{"name":"Documents resources"}],"security":[{"JWTBearer":[]}],"components":{"securitySchemes":{"JWTBearer":{"type":"http","scheme":"bearer"}},"schemas":{"SegmentsReply":{"properties":{"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","title":"Segments"}},"type":"object","required":["segments"],"title":"SegmentsReply"},"Segment":{"properties":{"id":{"type":"string","title":"Id"},"documentid":{"type":"string","title":"Documentid"},"status":{"$ref":"#/components/schemas/SegmentStatus"},"body":{"type":"string","title":"Body"},"pagenr":{"type":"integer","title":"Pagenr"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"tags":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Tags"},"lang":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lang"},"created":{"type":"string","format":"date-time","title":"Created"},"updated":{"type":"string","format":"date-time","title":"Updated"},"timeit":{"type":"integer","title":"Timeit"},"ordinal":{"type":"integer","title":"Ordinal"}},"type":"object","required":["id","documentid","status","body","pagenr","group","title","tags","lang","created","updated","timeit","ordinal"],"title":"Segment"},"SegmentStatus":{"type":"string","enum":["COMPLETED","FAILED"],"title":"SegmentStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/documents/{documentid}/segments":{"get":{"tags":["Documents resources"],"summary":"Document Segments","description":"return all document segments","operationId":"document_segments_documents__documentid__segments_get","parameters":[{"name":"documentid","in":"path","required":true,"schema":{"type":"string","title":"Documentid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentsReply"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```

## Document Segment

> return a document segment

```json
{"openapi":"3.1.0","info":{"title":"Helvia.ai Document Segmenter","version":"1.1.0"},"tags":[{"name":"Documents resources"}],"security":[{"JWTBearer":[]}],"components":{"securitySchemes":{"JWTBearer":{"type":"http","scheme":"bearer"}},"schemas":{"SegmentsReply":{"properties":{"segments":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array","title":"Segments"}},"type":"object","required":["segments"],"title":"SegmentsReply"},"Segment":{"properties":{"id":{"type":"string","title":"Id"},"documentid":{"type":"string","title":"Documentid"},"status":{"$ref":"#/components/schemas/SegmentStatus"},"body":{"type":"string","title":"Body"},"pagenr":{"type":"integer","title":"Pagenr"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"tags":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Tags"},"lang":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lang"},"created":{"type":"string","format":"date-time","title":"Created"},"updated":{"type":"string","format":"date-time","title":"Updated"},"timeit":{"type":"integer","title":"Timeit"},"ordinal":{"type":"integer","title":"Ordinal"}},"type":"object","required":["id","documentid","status","body","pagenr","group","title","tags","lang","created","updated","timeit","ordinal"],"title":"Segment"},"SegmentStatus":{"type":"string","enum":["COMPLETED","FAILED"],"title":"SegmentStatus"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/documents/{documentid}/segments/{segmentid}":{"get":{"tags":["Documents resources"],"summary":"Document Segment","description":"return a document segment","operationId":"document_segment_documents__documentid__segments__segmentid__get","parameters":[{"name":"documentid","in":"path","required":true,"schema":{"type":"string","title":"Documentid"}},{"name":"segmentid","in":"path","required":true,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Segmentid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentsReply"}}}},"404":{"description":"Not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}}
```