v1

latestOpenAPI 3.1.02026-07-1255227258.8 KB

partitions

Update Partition

Updates a partition. This includes the partition's description and metadata schema.

patch/partitions/{partition_id}

Path parameters

partition_idstring required

Request body

context_awareboolean nullable

Enable context-aware descriptions for the partition.

descriptionstring nullable

Description of the partition.

metadata_schemaobject nullable

Metadata schema for the partition. This is an optional subset of the metadata of documents in the partition, defined as JSON Schema, that can be used in filter generatation. Providing detailed descriptions of the fields in the schema can be helpful for LLMs generating filters dynamically.

Response

Successful Response

namestring required

is_defaultboolean required

limit_exceeded_atstring date-time nullable

Timestamp when the partition exceeded its limits, if applicable.

descriptionstring nullable required

context_awareboolean required

metadata_schemaobject nullable required

Example response

{
  "limit_exceeded_at": "2025-06-11T12:00:00Z",
  "limits": {
    "pages_processed_limit_monthly": 1000,
    "pages_hosted_limit_monthly": 1000,
    "pages_processed_limit_max": 1000,
    "pages_hosted_limit_max": 1000,
    "video_processed_limit_monthly": 60,
    "video_processed_limit_max": 60,
    "audio_processed_limit_monthly": 60,
    "audio_processed_limit_max": 60,
    "media_streamed_limit_monthly": 1024,
    "media_streamed_limit_max": 1024,
    "media_hosted_limit_monthly": 1024,
    "media_hosted_limit_max": 1024
  },
  "stats": {
    "pages_processed_monthly": 1000,
    "pages_hosted_monthly": 1000,
    "pages_processed_total": 1000,
    "pages_hosted_total": 1000,
    "document_count": 1000,
    "video_processed_monthly": 60,
    "video_processed_total": 60,
    "audio_processed_monthly": 60,
    "audio_processed_total": 60,
    "media_streamed_monthly": 1024,
    "media_streamed_total": 1024,
    "media_hosted_monthly": 1024,
    "media_hosted_total": 1024
  }
}