---
title: "Predict Service"
method: POST
path: "/v2/predict/{sname}"
---

# Predict Service

`POST /v2/predict/{sname}`

## Path parameters

- `sname` string, required

## Request body

- APIData
  - `description` string, nullable
  - `app` AppObj
    - `repository` union
      - string, directory-path
      - string, path
    - `create_repository` boolean
    - `models_repository` string
    - `init` string, uri, nullable
    - `verbose` 'info' | 'debug' | 'warning' | 'error' | 'critical'
  - `parameters` ParametersObj
    - `input` InputConnectorObj
      - `lib` string
      - `preprocessing` PreprocessingObj
        - `files` string[]
        - `lib` string
        - `save_output` boolean
        - `strict` boolean
        - `filters` string[]
        - `strategy` string
        - `cleaning` boolean
        - `dpi` integer
      - `rag` RAGObj
        - `indexdb_lib` string
        - `embedding_lib` 'gpt4all' | 'huggingface' | 'colbert'
        - `embedding_model` string
        - `embedding_model_path` string
        - `shared_model` boolean
        - `chunk_size` integer
        - `chunk_overlap` integer
        - `chunk_num` integer
        - `gpu_id` integer, nullable
        - `search` boolean
        - `reindex` boolean
        - `index_protection` boolean
        - `top_k` integer, nullable
        - `num_partitions` integer, nullable
        - `index_bsize` integer, nullable
        - `ragm` RAGMultimodalObj
          - `image_embedding_size` integer
          - `layout_detection` boolean
          - `layout_detector_gpu_id` integer, nullable
          - `image_width` integer, nullable
          - `image_height` integer, nullable
          - `auto_scale_for_font` boolean
          - `min_font_size` integer
          - `filter_width` integer, nullable
          - `filter_height` integer, nullable
          - `index_overview` boolean
      - `data_output_type` string
      - `template` TemplatePromptObj
        - `template_prompt` string, nullable
        - `template_prompt_variables` string[], nullable
      - `message` string, nullable
      - `data` string[], nullable
      - `session_id` string, nullable
      - `summarize` string, nullable
      - `index` IndexObj
        - `files` string[], nullable
        - `indexer` string, nullable
      - `query_depth_mult` integer
    - `llm` LLMModelObj
      - `source` string
      - `filename` string, nullable
      - `shared` boolean
      - `inference` LLMInferenceObj
        - `lib` string
        - `sampling_params` object
      - `context_size` integer
      - `quantization` string, nullable
      - `gpu_ids` integer[], nullable
      - `memory_utilization` number
      - `image_width` integer, nullable
      - `image_height` integer, nullable
      - `dtype` string
      - `host` string, nullable
      - `port` integer, nullable
      - `conversational` boolean
      - `stitch_crops` boolean
      - `load_in_8bit` boolean
    - `output` OutputConnectorObj
      - `postprocessing` string[], nullable
      - `output_format` string, nullable

## Response `200`

Successful Response

- APIResponse
  - `version` string, nullable
  - `status_code` integer, nullable
  - `status` StatusObj
    - `code` integer, nullable
    - `status` string, nullable
    - `colette_code` integer, nullable
    - `colette_message` string, nullable
  - `info` InfoObj
    - `services` string[], nullable
  - `service_name` string, nullable
  - `full_prompt` string, nullable
  - `full_response` object, nullable
  - `sources` object, nullable
  - `message` string, nullable
  - `output` string, nullable

## Other responses

- `422` — Validation Error

## Changes

- **2025-05-09** `a08d9da338cb` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/jolibrain/apis/colette-version-server/changes/v2/predict/:sname/post.md)

---

[API](https://skmtc.dev/jolibrain/apis/colette-version-server.md) · [All operations](https://skmtc.dev/jolibrain/apis/colette-version-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/jolibrain/colette-version-server/revisions/a08d9da338cb/schema)