v1

latestOpenAPI 3.1.02026-07-1255227258.8 KB

partitions

Create Partition

Create a new partition. Partitions are used to scope documents, connections, and instructions. Partitions must be lowercase alphanumeric and may only include the special characters _ and -. A partition may also be created by creating a document in it. Limits for a partition may optionally be defined when creating.

post/partitions

Request body

namestring required

descriptionstring nullable

Description of the partition. Automatic description generation can be enabled in the web dashboard.

pages_hosted_limit_monthlyinteger nullable

Monthly limit of hosted pages added in the current month in the partition.

pages_processed_limit_monthlyinteger nullable

Monthly limit, in pages, for processed documents in the partition.

pages_hosted_limit_maxinteger nullable

Maximum limit, in pages, for hosted documents in the partition.

pages_processed_limit_maxinteger nullable

Maximum limit, in pages, for processed documents in the partition.

audio_processed_limit_monthlyinteger nullable

Monthly limit, in minutes, for audio processing in the partition.

audio_processed_limit_maxinteger nullable

Maximum limit, in minutes, for audio processing in the partition.

video_processed_limit_monthlyinteger nullable

Monthly limit, in minutes, for video processing in the partition.

video_processed_limit_maxinteger nullable

Maximum limit, in minutes, for video processing in the partition.

media_streamed_limit_monthlyinteger nullable

Monthly limit, in MBs, for media streamed from the partition.

media_streamed_limit_maxinteger nullable

Maximum limit, in MBs, for media streamed from the partition.

media_hosted_limit_monthlyinteger nullable

Monthly limit, in MBs, for media hosted in the partition.

media_hosted_limit_maxinteger nullable

Maximum limit, in MBs, for media hosted in 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.

Example request

{
  "pages_hosted_limit_monthly": 1000,
  "pages_processed_limit_monthly": 1000,
  "pages_hosted_limit_max": 1000,
  "pages_processed_limit_max": 1000,
  "audio_processed_limit_monthly": 60,
  "audio_processed_limit_max": 60,
  "video_processed_limit_monthly": 60,
  "video_processed_limit_max": 60,
  "media_streamed_limit_monthly": 1024,
  "media_streamed_limit_max": 1024,
  "media_hosted_limit_monthly": 1024,
  "media_hosted_limit_max": 1024
}

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
  }
}