Skip to content
Full-Fill Docs

repository_files_retrieve

GET
/api/v2/repository/files/{id}/
curl --request GET \
  --url https://api.full-fill.ai/api/v2/repository/files/example/ \
  --header 'X-API-Key: <X-API-Key>'

ViewSet for repository file management.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
/^\d+$/

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Output serializer for listing files

object
id
integer
original_filename
string
nullable <= 256 characters
status
  • submitted - Submitted
  • processing - Processing
  • ready - Ready
  • failed - Failed
string
Allowed values: submitted processing ready failed
status_display
string
processing_stage
string
<= 20 characters
processing_percent
integer
>= -32768 <= 32767
document_type
  • questionnaire - Questionnaire
  • requirements_sheet - Requirements Sheet
  • qna - Qna
  • security_questionnaire - Security Questionnaire
  • security_certificate - Security Certificate
  • documentation - Documentation
  • data_extraction - Data Extraction
  • template - Template
  • unknown - Unknown
  • q_a - Q A
string
Allowed values: questionnaire requirements_sheet qna security_questionnaire security_certificate documentation data_extraction template unknown q_a
file_format
  • url - Url
  • doc - Doc
  • docx - Docx
  • excel - Excel
  • pdf - Pdf
  • gdrive - Gdrive
  • txt - Txt
  • ppt - Ppt
  • pptx - Pptx
  • html - Html
  • xml - Xml
string
Allowed values: url doc docx excel pdf gdrive txt ppt pptx html xml ""
source_provider

Integration provider this file was imported from (e.g., ‘google-drive’, ‘sharepoint’)

string
nullable <= 50 characters
created_at
string format: date-time
tags
Array<object>
object
id
integer
name
required
string
<= 50 characters
relevant_offerings
Array<object>

Brief offering info for file listings

object
id
integer
name
required

Name of the offering

string
<= 200 characters
type
required

Type of offering

  • service - Service
  • product - Product
  • module - Module
string
Allowed values: service product module
scope_includes_company

Whether this file/questionnaire scope includes the company generally (not just specific offerings)

boolean
use_as_source
boolean
url
string
nullable <= 1024 characters
user
string
qa_count
integer
0
data_count
integer
0
passage_count
integer
0
total_embeddings
integer
is_reprocessable
boolean
Example
{
  "status": "submitted",
  "document_type": "questionnaire",
  "file_format": "url",
  "relevant_offerings": [
    {
      "type": "service"
    }
  ],
  "qa_count": 0,
  "data_count": 0,
  "passage_count": 0
}