v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

RAG

Create a new rag

Creates a new RAG knowledge base with document sources. Documents are ingested asynchronously.

post/rags

Request body

namestring required

Human-readable name for the rag.

descriptionstring

Description of what this rag contains.

storage_file_idsstring[]

List of storage file IDs to ingest. Obtained from the id field of POST /storage_files response.

source_urlsstring[]

List of URLs to fetch and ingest as documents.

Example request

{
  "name": "Customer Support KB",
  "description": "Knowledge base for customer support conversations",
  "storage_file_ids": [
    "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  ],
  "source_urls": [
    "https://example.com/docs/faq.html"
  ]
}

Response

Successfully created rag.

idstring uuid

The unique identifier of the rag. Returned from the POST /rags response.

customer_idstring uuid

The customer ID that owns this rag.

namestring

Human-readable name for the rag.

descriptionstring

Description of what this rag contains.

tm_createstring date-time

Timestamp when the rag was created.

tm_updatestring date-time

Timestamp when the rag was last updated.

status'pending' | 'processing' | 'ready' | 'error'

The document processing status. Indicates the current stage of document ingestion.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "customer_id": "7d4e8f2a-1b3c-4d5e-9f6a-8b7c6d5e4f3a",
  "name": "Customer Support KB",
  "description": "Knowledge base for customer support conversations",
  "tm_create": "2026-03-18T10:30:00Z",
  "tm_update": "2026-03-18T10:30:00Z",
  "status": "ready",
  "sources": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "customer_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "storage_file_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "source_url": "https://example.com/docs/faq.html",
      "status": "ready",
      "status_message": "Document parsed and 42 chunks created"
    }
  ]
}