Headers

• X-API-Version string

  Default value is 2025-03-25.

Query parameters

• status string

  Filter knowledge base entries by their processing status. Use this to find entries in specific states like READY or those with errors.

  Values are AWAITING_UPLOAD, SUPABASE_ONLY, PROCESSING, READY, SYNC_ERROR, ERR_FILE_PROCESSING, ERR_TEXT_PROCESSING, ERR_TEXT_TO_VECTOR, or BLANK.

• type string

  Filter knowledge base entries by their content type. Use this to find specific types of training data like text or file uploads.

  Values are file_upload, url, training_history, or text.

• page string

  Page number for pagination. Use this to navigate through large result sets.

  Format should match the following pattern: ^\d+$. Default value is 1.

• limit string

  Maximum number of entries to return per page (up to 100). Use this to control result set size.

  Format should match the following pattern: ^\d+$. Default value is 100.

Responses

• 200 application/json

  List of knowledge base entries returned successfully.

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates if the list operation was successful

  • items array[object] Required

    Array of knowledge base entries matching your query parameters

    Hide items attributes Show items attributes object

    • id integer Required

      The unique identifier for this knowledge base entry. Use this ID in subsequent API calls to update or delete this entry.

    • replica_uuid string | null Required

      The unique identifier of the replica that owns this knowledge base entry. This links the training data to a specific replica.

    • type string Required

      The type of knowledge base entry, indicating how the content was added and how it should be processed.

      Values are file_upload, url, training_history, or text.

    • filename string | null Required

      For file_upload entries, the original filename that was uploaded. This helps identify the source of the content.

    • url string

      For url entries, the original url of the content.

    • status string Required

      The current stage in the processing pipeline. Use this to track progress and identify any issues with processing.

      Values are AWAITING_UPLOAD, SUPABASE_ONLY, PROCESSING, READY, SYNC_ERROR, ERR_FILE_PROCESSING, ERR_TEXT_PROCESSING, ERR_TEXT_TO_VECTOR, or BLANK.

    • raw_text string | null Required

      The original, unmodified text content that was submitted for training. May be truncated for large entries.

    • processed_text string | null Required

      The optimized version of the text after system processing. This is what gets converted to vectors for retrieval.

    • created_at string(date-time) Required

      ISO 8601 timestamp when this knowledge base entry was first created.

    • updated_at string(date-time) Required

      ISO 8601 timestamp when this knowledge base entry was last modified. Use this to track when processing completed.

    • title string | null Required

      Title for this knowledge base entry. Helps identify the content in listings.

    • description string | null Required

      Optional description providing more details about this knowledge base entry.

• 400 application/json

  Bad Request

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • fingerprint string

    A unique identifier of the event, useful for reporting

  • request_id string Required

    A unique identifier of the request, useful for reporting

• 401 application/json

  Unauthorized

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • fingerprint string

    A unique identifier of the event, useful for reporting

  • request_id string Required

    A unique identifier of the request, useful for reporting

• 404 application/json

  Not Found

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • request_id string Required

    A unique identifier of the request, useful for reporting

• 415 application/json

  Unsupported Media Type

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • fingerprint string

    A unique identifier of the event, useful for reporting

  • request_id string Required

    A unique identifier of the request, useful for reporting

• 500 application/json

  Internal Server Error

  Hide response attributes Show response attributes object

  • success boolean Required

    Indicates the status of the request

  • error string Required

    A text representation of the error

  • fingerprint string

    A unique identifier of the event, useful for reporting

  • request_id string Required

    A unique identifier of the request, useful for reporting

  • inner_exception object

    The inner exception

    Hide inner_exception attributes Show inner_exception attributes object

    • name string Required
    • message string Required
    • cause string
    • stack string