ENTITY developer reference
ServingLimits
Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.
This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.
This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.
Enforced before expensive serving. Exhaustion returns a truthful bounded limit outcome; no implicit read fee, research or fresh verification clock.
Declared type: "object"
Declared fields
This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.
included_requests_per_period
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for included_requests_per_period
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}included_response_bytes_per_period
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for included_response_bytes_per_period
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
}requests_per_second
Listed in this schema’s required array.
- Declared type
"integer"
Reading definition for requests_per_second
{
"type": "integer",
"minimum": 1
}burst_requests
Listed in this schema’s required array.
- Declared type
"integer"
Reading definition for burst_requests
{
"type": "integer",
"minimum": 1
}concurrent_requests
Listed in this schema’s required array.
- Declared type
"integer"
Reading definition for concurrent_requests
{
"type": "integer",
"minimum": 1
}period_policy
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for period_policy
{
"$ref": "#/components/schemas/PolicyPin"
}Schema reading view
Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.
{
"type": "object",
"additionalProperties": false,
"properties": {
"included_requests_per_period": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
},
"included_response_bytes_per_period": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"maxLength": 30,
"x-profile-maxLength": "string_characters_max"
},
"requests_per_second": {
"type": "integer",
"minimum": 1
},
"burst_requests": {
"type": "integer",
"minimum": 1
},
"concurrent_requests": {
"type": "integer",
"minimum": 1
},
"period_policy": {
"$ref": "#/components/schemas/PolicyPin"
}
},
"required": [
"included_requests_per_period",
"included_response_bytes_per_period",
"requests_per_second",
"burst_requests",
"concurrent_requests",
"period_policy"
],
"description": "Enforced before expensive serving. Exhaustion returns a truthful bounded limit outcome; no implicit read fee, research or fresh verification clock."
}