v1

latestOpenAPI 3.1.02026-07-1255227258.8 KB

partitions

Set Partition Limits

Sets limits on a partition. Limits can be set on the total number of pages a partition can host and process. When the limit is reached, the partition will be disabled. A limit may be removed by setting it to null.

put/partitions/{partition_id}/limits

Path parameters

partition_idstring required

Request body

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.

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.

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.

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.

Example request

{
  "pages_hosted_limit_monthly": 1000,
  "pages_processed_limit_monthly": 1000,
  "pages_hosted_limit_max": 1000,
  "pages_processed_limit_max": 1000,
  "video_processed_limit_monthly": 3600,
  "video_processed_limit_max": 3600,
  "audio_processed_limit_monthly": 3600,
  "audio_processed_limit_max": 3600,
  "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
  },
  "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
  }
}