> ## Documentation Index > Fetch the complete documentation index at: https://docs.gp.scale.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Upload Job ## OpenAPI ````yaml https://app.stainlessapi.com/api/spec/documented/sgp/openapi.yml get /v4/knowledge-bases/{knowledge_base_id}/uploads/{upload_id} openapi: 3.1.0 info: title: EGP API V4 description: >- This is the parent API for all EGP APIs. If you are looking for the EGP API, please go to https://api.egp.scale.com/docs. contact: name: Scale Generative AI Platform url: https://scale.com/genai-platform version: 0.1.0 servers: - url: https://api.egp.scale.com security: [] tags: - name: Models description: Model API. paths: /v4/knowledge-bases/{knowledge_base_id}/uploads/{upload_id}: get: tags: - Knowledge Bases summary: Get Upload Job operationId: GET-V4-/v2/knowledge-bases/{knowledge_base_id}/uploads/{upload_id} parameters: - name: knowledge_base_id in: path required: true schema: type: string title: Knowledge Base Id - name: upload_id in: path required: true schema: type: string title: Upload Id - name: include_artifact_list in: query required: false schema: type: boolean default: true title: Include Artifact List - name: x-selected-account-id in: header required: false schema: anyOf: - type: string - type: 'null' title: Account ID Header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GetKnowledgeBaseV2UploadResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] x-codeSamples: - lang: Python source: |- import os from scale_gp import SGPClient client = SGPClient( api_key=os.environ.get("SGP_API_KEY"), # This is the default and can be omitted ) knowledge_base_upload = client.knowledge_bases.uploads.retrieve( upload_id="upload_id", knowledge_base_id="knowledge_base_id", ) print(knowledge_base_upload.upload_id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/stainless-sdks/sgp-go\"\n\t\"github.com/stainless-sdks/sgp-go/option\"\n)\n\nfunc main() {\n\tclient := sgp.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tknowledgeBaseUpload, err := client.KnowledgeBases.Uploads.Get(\n\t\tcontext.TODO(),\n\t\t\"knowledge_base_id\",\n\t\t\"upload_id\",\n\t\tsgp.KnowledgeBaseUploadGetParams{},\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", knowledgeBaseUpload.UploadID)\n}\n" components: schemas: GetKnowledgeBaseV2UploadResponse: properties: upload_id: type: string title: Upload Id description: Unique ID of the upload job. data_source_config: $ref: '#/components/schemas/DataSourceConfig' description: Configuration for downloading data from source. chunking_strategy_config: $ref: '#/components/schemas/ChunkingStrategyConfig' description: Configuration for chunking the text content of each artifact. created_at: type: string title: Created At description: The timestamp at which the upload job started. updated_at: type: string title: Updated At description: The timestamp at which the upload job was last updated. status: $ref: '#/components/schemas/UploadJobStatus' description: Sync status status_reason: title: Status Reason description: Reason for the upload job's status. type: string artifacts_status: $ref: '#/components/schemas/ArtifactsStatus' description: >- Number of artifacts in each of the various states, such as completed and failed for this upload. This includes artifacts for this data source that are retried. artifacts: title: Artifacts description: >- List of info for each artifacts associated with this upload. This includes artifacts for this data source that are retried. items: $ref: >- #/components/schemas/egp_api_backend__server__api__models__egp_models__ArtifactInfo type: array created_by_schedule_id: title: Created By Schedule Id description: >- Id of the upload schedule that triggered this upload_id. Null if triggered manually. type: string type: object required: - upload_id - data_source_config - created_at - updated_at - status - artifacts_status - artifacts title: GetKnowledgeBaseV2UploadResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError DataSourceConfig: oneOf: - $ref: '#/components/schemas/S3DataSourceConfig' - $ref: '#/components/schemas/SharePointDataSourceConfig' - $ref: '#/components/schemas/SharePointPageDataSourceConfig' - $ref: '#/components/schemas/GoogleDriveDataSourceConfig' - $ref: '#/components/schemas/AzureBlobStorageDataSourceConfig' - $ref: '#/components/schemas/GoogleCloudStorageDataSourceConfig' - $ref: '#/components/schemas/LocalChunksSourceConfig' - $ref: '#/components/schemas/LocalFileSourceConfig' - $ref: '#/components/schemas/ConfluenceDataSourceConfig' - $ref: '#/components/schemas/SlackDataSourceConfig' - $ref: '#/components/schemas/SnowflakeDataSourceConfig' - $ref: '#/components/schemas/DatabricksDataSourceConfig' - $ref: '#/components/schemas/SQLDatabaseDataSourceConfig' - $ref: '#/components/schemas/MongoDBDataSourceConfig' - $ref: '#/components/schemas/BigQueryDataSourceConfig' title: DataSourceConfig discriminator: propertyName: source mapping: AzureBlobStorage: $ref: '#/components/schemas/AzureBlobStorageDataSourceConfig' BigQuery: $ref: '#/components/schemas/BigQueryDataSourceConfig' Confluence: $ref: '#/components/schemas/ConfluenceDataSourceConfig' Databricks: $ref: '#/components/schemas/DatabricksDataSourceConfig' GoogleCloudStorage: $ref: '#/components/schemas/GoogleCloudStorageDataSourceConfig' GoogleDrive: $ref: '#/components/schemas/GoogleDriveDataSourceConfig' LocalChunks: $ref: '#/components/schemas/LocalChunksSourceConfig' LocalFile: $ref: '#/components/schemas/LocalFileSourceConfig' MongoDB: $ref: '#/components/schemas/MongoDBDataSourceConfig' S3: $ref: '#/components/schemas/S3DataSourceConfig' SQLDatabase: $ref: '#/components/schemas/SQLDatabaseDataSourceConfig' SharePoint: $ref: '#/components/schemas/SharePointDataSourceConfig' SharePointPage: $ref: '#/components/schemas/SharePointPageDataSourceConfig' Slack: $ref: '#/components/schemas/SlackDataSourceConfig' Snowflake: $ref: '#/components/schemas/SnowflakeDataSourceConfig' ChunkingStrategyConfig: oneOf: - $ref: '#/components/schemas/CharacterChunkingStrategyConfig' - $ref: '#/components/schemas/TokenChunkingStrategyConfig' - $ref: '#/components/schemas/CustomChunkingStrategyConfig' - $ref: '#/components/schemas/PreChunkedStrategyConfig' - $ref: '#/components/schemas/EnhancedChunkingStrategyConfig' title: ChunkingStrategyConfig discriminator: propertyName: strategy mapping: character: $ref: '#/components/schemas/CharacterChunkingStrategyConfig' custom: $ref: '#/components/schemas/CustomChunkingStrategyConfig' enhanced: $ref: '#/components/schemas/EnhancedChunkingStrategyConfig' pre_chunked: $ref: '#/components/schemas/PreChunkedStrategyConfig' token: $ref: '#/components/schemas/TokenChunkingStrategyConfig' UploadJobStatus: type: string enum: - Running - Completed - Failed - Canceled title: UploadJobStatus ArtifactsStatus: properties: artifacts_chunking: type: integer title: Artifacts Chunking description: Number of artifacts in the chunking state artifacts_embedding: type: integer title: Artifacts Embedding description: Number of artifacts in the embedding state artifacts_completed: type: integer title: Artifacts Completed description: Number of artifacts uploaded successfully. artifacts_pending: type: integer title: Artifacts Pending description: >- Previously: Number of artifacts awaiting upload. Note that this status will be deprecated soon and should show 0 artifacts_uploading: type: integer title: Artifacts Uploading description: Number of artifacts with upload in progress. artifacts_failed: type: integer title: Artifacts Failed description: Number of artifacts that failed while being processed. type: object required: - artifacts_chunking - artifacts_embedding - artifacts_completed - artifacts_pending - artifacts_uploading - artifacts_failed title: ArtifactsStatus egp_api_backend__server__api__models__egp_models__ArtifactInfo: properties: artifact_id: type: string title: Artifact Id description: Unique identifier for the artifact. artifact_name: type: string title: Artifact Name description: Friendly name for the artifact. artifact_uri: type: string title: Artifact Uri description: Location (e.g. URI) of the artifact in the data source. artifact_uri_public: title: Artifact Uri Public description: Public Location (e.g. URI) of the artifact in the data source. type: string status: type: string title: Status description: Status of the artifact. status_reason: title: Status Reason description: Reason for the artifact's status. type: string source: $ref: '#/components/schemas/ArtifactSource' description: Data source of the artifact. chunks_status: $ref: >- #/components/schemas/egp_api_backend__server__api__models__egp_models__ChunksStatus description: Number of chunks pending, completed, and failed. updated_at: title: Updated At description: Timestamp at which the artifact was last updated. type: string format: date-time tags: title: Tags description: Tags associated with the artifact. additionalProperties: true type: object type: object required: - artifact_id - artifact_name - artifact_uri - status - source - chunks_status - tags title: ArtifactInfo ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context additionalProperties: true type: object required: - loc - msg - type title: ValidationError S3DataSourceConfig: properties: source: type: string const: S3 title: Source s3_bucket: type: string title: S3 Bucket description: Name of the S3 bucket where the data is stored. s3_prefix: type: string title: S3 Prefix description: >- Prefix of the S3 bucket where the data is stored. If not specified, the entire bucket will be used. default: '' aws_region: type: string title: Aws Region description: AWS region where the S3 bucket is located. aws_account_id: type: string pattern: ^\d{12}$ title: Aws Account Id description: AWS account ID that owns the S3 bucket. type: object required: - source - s3_bucket - aws_region - aws_account_id title: S3 DataSource Config SharePointDataSourceConfig: properties: source: type: string const: SharePoint title: Source client_id: type: string title: Client Id description: Client ID associated with this SharePoint site tenant_id: type: string title: Tenant Id description: Tenant ID that the SharePoint site is within site_id: type: string title: Site Id description: >- Site ID for this SharePoint site, can be found at https://[hostname].sharepoint.com/sites/[site name]/_api/site/id folder_path: title: Folder Path description: >- Nested folder path to read files from the root of the site. Please omit the leading slash. Example: 'Documents/sub_directory' default: '' type: string recursive: title: Recursive description: Recurse through the folder contents, default is True. default: true type: boolean type: object required: - source - client_id - tenant_id - site_id title: SharePoint DataSource Config SharePointPageDataSourceConfig: properties: source: type: string const: SharePointPage title: Source client_id: type: string title: Client Id description: Client ID associated with this SharePoint site tenant_id: type: string title: Tenant Id description: Tenant ID that the SharePoint site is within site_id: type: string title: Site Id description: Site ID for this SharePoint site type: object required: - source - client_id - tenant_id - site_id title: SharePoint Page DataSource Config GoogleDriveDataSourceConfig: properties: source: type: string const: GoogleDrive title: Source drive_id: type: string title: Drive Id description: ID associated with the Google Drive to retrieve contents from type: object required: - source - drive_id title: Google Drive DataSource Config AzureBlobStorageDataSourceConfig: properties: source: type: string const: AzureBlobStorage title: Source container_url: type: string title: Container Url description: >- The full URL of the container such as 'https://your-account-name.blob.core.windows.net/your-container-name' type: object required: - source - container_url title: Azure Blob Storage DataSource Config GoogleCloudStorageDataSourceConfig: properties: source: type: string const: GoogleCloudStorage title: Source bucket: type: string title: Bucket description: Name of the Google Cloud Storage bucket where the data is stored. prefix: title: Prefix description: >- Prefix path within the Google Cloud Storage bucket. If not specified, the entire bucket will be used. type: string project_id: title: Project Id description: >- GCP project ID that owns the Google Cloud Storage bucket. If not specified, uses the default project. type: string type: object required: - source - bucket title: Google Cloud Storage DataSource Config LocalChunksSourceConfig: properties: source: type: string const: LocalChunks title: Source artifact_name: type: string title: Artifact Name description: >- The file name assigned to the artifact, containing a file extension. Adding an extension is mandatory, to allow detecting file types for text extraction. artifact_uri: type: string title: Artifact Uri description: >- A unique identifier for an artifact within the knowledge base, such as full path in a directory or file system. deduplication_strategy: $ref: '#/components/schemas/DeduplicationStrategy' description: >- Action to take if an artifact with the same name already exists in the knowledge base. Can be either Overwrite (default) or Fail. default: Overwrite type: object required: - source - artifact_name - artifact_uri title: LocalChunksSourceConfig LocalFileSourceConfig: properties: source: type: string const: LocalFile title: Source deduplication_strategy: $ref: '#/components/schemas/DeduplicationStrategy' description: >- Action to take if an artifact with the same name already exists in the knowledge base. Can be either Overwrite (default) or Fail. default: Overwrite type: object required: - source title: LocalFileSourceConfig ConfluenceDataSourceConfig: properties: source: type: string const: Confluence title: Source space_key: type: string title: Space Key description: >- Confluence space key to retrieve contents from. See https://support.atlassian.com/confluence-cloud/docs/choose-a-space-key type: object required: - source - space_key title: Confluence DataSource Config SlackDataSourceConfig: properties: source: type: string const: Slack title: Source channel_id: type: string title: Channel Id description: >- Slack Channel or Conversation ID to retrieve history from. Open channel details and find the ID at bottom of 'About' section. type: object required: - source - channel_id title: Slack DataSource Config SnowflakeDataSourceConfig: properties: source: type: string const: Snowflake title: Source account: type: string title: Account description: Snowflake account identifier user: type: string title: User description: Snowflake user name type: object required: - source - account - user title: Snowflake DataSource Config DatabricksDataSourceConfig: properties: source: type: string const: Databricks title: Source server_hostname: type: string title: Server Hostname description: Databricks server hostname http_path: type: string title: Http Path description: HTTP path for the Databricks cluster or SQL warehouse type: object required: - source - server_hostname - http_path title: Databricks DataSource Config SQLDatabaseDataSourceConfig: properties: source: type: string const: SQLDatabase title: Source dialect: type: string enum: - postgresql - mssql - sqlite - snowflake title: Dialect description: SQL dialect to use for connection host: title: Host description: Database server hostname or IP address type: string port: title: Port description: Database server port type: integer database: type: string title: Database description: Name of the database to connect to. username: title: Username description: Username for authentication type: string driver: title: Driver description: >- ODBC driver name for MSSQL connections. Defaults to 'ODBC Driver 18 for SQL Server' if not specified. type: string ssl_mode: title: Ssl Mode description: SSL mode for PostgreSQL connections (e.g., 'require', 'verify-full') type: string connect_timeout: title: Connect Timeout description: Connection timeout in seconds default: 30 type: integer connection_options: title: Connection Options description: >- Additional connection parameters appended to the URL (e.g., {'sslrootcert': '/path/to/ca.pem', 'application_name': 'myapp'}) additionalProperties: type: string type: object account: title: Account description: >- Snowflake account identifier (e.g., 'xy12345' or 'xy12345.us-east-2.azure'). Do NOT include the '.snowflakecomputing.com' suffix. type: string warehouse: title: Warehouse description: >- Snowflake warehouse name for query execution. Required for Snowflake. type: string schema_name: title: Schema Name description: Snowflake schema name. Defaults to 'PUBLIC' if not specified. type: string role: title: Role description: >- Snowflake role for authentication. Uses the default role for the user if not specified. type: string type: object required: - source - dialect - database title: SQL Database DataSource Config MongoDBDataSourceConfig: properties: source: type: string const: MongoDB title: Source database: type: string title: Database description: Database name to connect to connect_timeout: title: Connect Timeout description: Connection timeout in seconds default: 30 type: integer type: object required: - source - database title: MongoDB DataSource Config BigQueryDataSourceConfig: properties: source: type: string const: BigQuery title: Source project_id: type: string title: Project Id description: GCP project ID containing the BigQuery dataset(s) to query. location: title: Location description: >- BigQuery dataset location (e.g. 'US', 'EU', 'us-central1'). When omitted the client uses the project's default location. type: string connect_timeout: title: Connect Timeout description: Connection timeout in seconds for BigQuery API calls. default: 30 type: integer type: object required: - source - project_id title: BigQuery DataSource Config CharacterChunkingStrategyConfig: properties: strategy: type: string const: character title: Strategy separator: title: Separator description: >- Character designating breaks in input data. Text data will first be split into sections by this separator, then each section will be split into chunks of size `chunk_size`. default: |+ type: string chunk_size: title: Chunk Size description: >- Maximum number of characters in each chunk. If not specified, a chunk size of 1000 will be used. default: 1000 type: integer minimum: 1 chunk_overlap: title: Chunk Overlap description: >- Number of characters to overlap between chunks. If not specified, an overlap of 200 will be used. For example if the chunk size is 3 and the overlap size is 1, and the text to chunk is 'abcde', the chunks will be 'abc', 'cde'. default: 200 type: integer minimum: 0 type: object required: - strategy title: CharacterChunkingStrategyConfig TokenChunkingStrategyConfig: properties: strategy: type: string const: token title: Strategy separator: title: Separator description: >- Character designating breaks in input data. Text data will first be split into sections by this separator, then each section will be split into chunks of size `chunk_size`. default: |+ type: string target_chunk_size: title: Target Chunk Size description: >- Target number of tokens in each chunk. If not specified, a target chunk size of 200 will be used. default: 200 type: integer minimum: 1 max_chunk_size: title: Max Chunk Size description: >- Maximum number of tokens in each chunk. If not specified, a maximum chunk size of 600 will be used. default: 600 type: integer minimum: 1 chunk_overlap: title: Chunk Overlap description: >- Number of tokens to overlap between chunks. If not specified, an overlap of 0 will be used. Not this if only followed approximately. default: 0 type: integer minimum: 0 type: object required: - strategy title: TokenChunkingStrategyConfig CustomChunkingStrategyConfig: properties: strategy: type: string const: custom title: Strategy endpoint: type: string title: Endpoint description: Endpoint path to call for custom chunking params: title: Params description: >- Parameters that will be appended to the body of the request for the chunk. default: {} additionalProperties: true type: object type: object required: - strategy - endpoint title: CustomChunkingStrategyConfig PreChunkedStrategyConfig: properties: strategy: type: string const: pre_chunked title: Strategy type: object required: - strategy title: PreChunkedStrategyConfig description: Only compliant with the .chunks file type EnhancedChunkingStrategyConfig: properties: strategy: type: string const: enhanced title: Strategy default: enhanced chunk_mode: type: string enum: - variable - section - page - page_sections - block title: Chunk Mode description: Enhanced internal chunking method default: section options: title: Options description: Options for enhanced parsing additionalProperties: true type: object advanced_options: title: Advanced Options description: Advanced options for enhanced parsing additionalProperties: true type: object experimental_options: title: Experimental Options description: Experimental options for enhanced parsing additionalProperties: true type: object use_async_parsing: type: boolean title: Use Async Parsing default: false type: object title: EnhancedChunkingStrategyConfig description: Enhanced document parsing and chunking ArtifactSource: type: string enum: - S3 - Confluence - SharePoint - SharePointPage - GoogleDrive - GoogleCloudStorage - AzureBlobStorage - Slack - Snowflake - Databricks - LocalFile - LocalChunks title: ArtifactSource egp_api_backend__server__api__models__egp_models__ChunksStatus: properties: chunks_completed: type: integer title: Chunks Completed description: Number of chunks uploaded successfully. chunks_pending: type: integer title: Chunks Pending description: Number of chunks awaiting upload. chunks_failed: type: integer title: Chunks Failed description: Number of chunks that failed upload. type: object required: - chunks_completed - chunks_pending - chunks_failed title: ChunksStatus DeduplicationStrategy: type: string enum: - Overwrite - Fail title: DeduplicationStrategy securitySchemes: APIKeyHeader: type: apiKey in: header name: x-api-key ````