Schemas

The one and only member of an error body — there is never a partial resource beside it.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The role's name, as member pickers show it — unique in the account, surrounding spaces dropped, at most 100 characters. A second role of the same name is ALREADY_EXISTS. The list is ordered by it.

What the role is for, in a sentence a member picker can show next to the choice; at most 1000 characters, empty when there is none.

What the role holds, as {permission, level} — a section id from permissions and READ or WRITE. A grant covers the section's whole subtree and brings its implies along. Every member holding the role holds exactly these, and a change counts from their next request. Nobody may define a role wider than their own: that is PERMISSION_DENIED.

How many members of the account hold the role now. A role that a member holds, or that an invitation names, cannot be deleted.

The role's name, as member pickers show it — unique in the account, surrounding spaces dropped, at most 100 characters. A second role of the same name is ALREADY_EXISTS. The list is ordered by it.

What the role is for, in a sentence a member picker can show next to the choice; at most 1000 characters, empty when there is none.

What the role holds, as {permission, level} — a section id from permissions and READ or WRITE. A grant covers the section's whole subtree and brings its implies along. Every member holding the role holds exactly these, and a change counts from their next request. Nobody may define a role wider than their own: that is PERMISSION_DENIED.

The role's name, as member pickers show it — unique in the account, surrounding spaces dropped, at most 100 characters. A second role of the same name is ALREADY_EXISTS. The list is ordered by it.

What the role is for, in a sentence a member picker can show next to the choice; at most 1000 characters, empty when there is none.

What the role holds, as {permission, level} — a section id from permissions and READ or WRITE. A grant covers the section's whole subtree and brings its implies along. Every member holding the role holds exactly these, and a change counts from their next request. Nobody may define a role wider than their own: that is PERMISSION_DENIED.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The address the invitation is mailed to, stored lowercase. One pending invitation per address: inviting it again, or inviting a member's address, is ALREADY_EXISTS. The list is ordered by it.

The role the membership will hold once the invitation is accepted: roles/admin, roles/editor or roles/sections (see roles), or one of the account's own, accounts/{account}/roles/{role}. Nobody may invite with a role wider than their own: that is PERMISSION_DENIED.

The sections a roles/sections invitation grants, as {permission, level} — a section id from permissions and READ or WRITE. Empty, and refused when sent, under any other role. Nobody may grant a section they do not hold themselves.

The member who sent the invitation, as users/{user}; absent once that user no longer exists.

PENDING until expire_time, then EXPIRED: the link no longer works, but the invitation stays listed for 30 days so it can be sent again with :resend — or withdrawn. An accepted invitation is gone.

When the link stops working: 7 days after the invitation was sent, or sent again.

The address the invitation is mailed to, stored lowercase. One pending invitation per address: inviting it again, or inviting a member's address, is ALREADY_EXISTS. The list is ordered by it.

The role the membership will hold once the invitation is accepted: roles/admin, roles/editor or roles/sections (see roles), or one of the account's own, accounts/{account}/roles/{role}. Nobody may invite with a role wider than their own: that is PERMISSION_DENIED.

The sections a roles/sections invitation grants, as {permission, level} — a section id from permissions and READ or WRITE. Empty, and refused when sent, under any other role. Nobody may grant a section they do not hold themselves.

An idempotency key you choose, at most 64 characters. Creating with a key already used in this account returns the invitation that key created, and mails nothing.

The address the invitation is mailed to, stored lowercase. One pending invitation per address: inviting it again, or inviting a member's address, is ALREADY_EXISTS. The list is ordered by it.

The role the membership will hold once the invitation is accepted: roles/admin, roles/editor or roles/sections (see roles), or one of the account's own, accounts/{account}/roles/{role}. Nobody may invite with a role wider than their own: that is PERMISSION_DENIED.

The sections a roles/sections invitation grants, as {permission, level} — a section id from permissions and READ or WRITE. Empty, and refused when sent, under any other role. Nobody may grant a section they do not hold themselves.

An idempotency key you choose, at most 64 characters. Creating with a key already used in this account returns the invitation that key created, and mails nothing.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The member, as users/{user} — the same name the account's owner uses. The last segment is also this membership's id.

The member's email address, from their user profile. The list is ordered by it.

The member's first name, from their user profile; absent when they gave none.

The member's last name, from their user profile; absent when they gave none.

The membership's role: roles/admin, roles/editor or roles/sections (see roles), or one of the account's own, accounts/{account}/roles/{role} — never another account's. The owner's membership reads roles/admin — dormant while they own the account, and what they keep after handing it over — and cannot be changed. Nobody may give a role wider than their own: that is PERMISSION_DENIED.

The sections a roles/sections membership holds, as {permission, level} — a section id from permissions and READ or WRITE. Empty, and refused when sent, under any other role. Nobody may give a grant they do not hold themselves.

True for the account's one owner, who holds everything whatever the role says. The owner's membership is neither removed nor changed; the account is handed over first (accounts/{account}:transfer_ownership).

What the member actually holds, computed on every read: the role's grants — or the membership's own — with implies followed, minimal and in the order of permissions. The owner's are everything. Sections every member may read are readable whatever this says.

The membership's role: roles/admin, roles/editor or roles/sections (see roles), or one of the account's own, accounts/{account}/roles/{role} — never another account's. The owner's membership reads roles/admin — dormant while they own the account, and what they keep after handing it over — and cannot be changed. Nobody may give a role wider than their own: that is PERMISSION_DENIED.

The sections a roles/sections membership holds, as {permission, level} — a section id from permissions and READ or WRITE. Empty, and refused when sent, under any other role. Nobody may give a grant they do not hold themselves.

The membership's role: roles/admin, roles/editor or roles/sections (see roles), or one of the account's own, accounts/{account}/roles/{role} — never another account's. The owner's membership reads roles/admin — dormant while they own the account, and what they keep after handing it over — and cannot be changed. Nobody may give a role wider than their own: that is PERMISSION_DENIED.

The sections a roles/sections membership holds, as {permission, level} — a section id from permissions and READ or WRITE. Empty, and refused when sent, under any other role. Nobody may give a grant they do not hold themselves.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The section this one belongs to, as its resource name. Absent on the two roots — account, everything about the account itself, and website, everything inside its websites. A grant on a section covers every section under it.

The section's name as a person reads it, in English. tenant-admin shows its own translation, looked up by id, and falls back to this one.

What a grant on this section lets a member do, in a sentence or two a role editor can show as help text.

True where every member of the account may read without any grant — everything inside the websites, and the account's settings and projects — so that every picker works under every role. On such a section a READ grant only decides whether it shows in the menu; changing anything still takes WRITE.

The grants holding this section brings along, as {when, permission, level}: whoever holds when (READ or WRITE) on this section — or on a section above it — holds level on permission too. It is what keeps a narrow role usable: writing a theme uploads its logo, so it brings writing to the media library with it. Empty on most sections.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The role's name as a person reads it, in English.

What a member with this role may do, in a sentence or two a member picker can show next to the choice.

What the role holds, as {permission, level} — computed from permissions on every read rather than stored, so a section a new release adds is in roles/admin and roles/editor the day it ships. Minimal: no grant that another one already covers, and implies already followed. Empty for roles/sections, whose grants are each membership's own.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The account's label, as the admin shows it in the account switcher.

Whether the account is in use. An inactive one is invisible on this surface: the list skips it and a read answers NOT_FOUND.

The member who owns the account, as users/{user}: whoever created it, or the first member of an account made for them. An account has exactly one owner; neither Create nor Update sets it, and only the owner moves it, with :transfer_ownership. The owner may do everything in the account whatever their role says, is the only member who may delete it or hand it over, and can be neither removed from it nor leave it.

The account's label, as the admin shows it in the account switcher.

Whether the account is in use. An inactive one is invisible on this surface: the list skips it and a read answers NOT_FOUND.

The account's label, as the admin shows it in the account switcher.

Whether the account is in use. An inactive one is invisible on this surface: the list skips it and a read answers NOT_FOUND.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The AI balance as Money: what runs on the platform's key (MANAGED) are paid from. It is the balance after the latest row of ai_transactions, and it can be negative when runs started together spent past it.

The currency the balance, the limits and every charge are kept in (ISO 4217).

The most the account may spend on the platform's key in a calendar month (UTC), as Money. A run that could take the month past it is refused before it starts. Leave it unset for no limit.

The most the account may spend on the platform's key in a calendar day (UTC), as Money. A run that could take the day past it is refused before it starts.

The most runs the account may have queued or running at once, on any connection. A run created past it is refused with CONCURRENCY_LIMIT_REACHED.

The platform's monthly ceiling for this account, as Money. It applies over monthly_limit: the lower of the two is the one in force.

The platform's daily ceiling for this account, as Money, in force over daily_limit.

The platform's ceiling on runs queued or running at once for this account, in force over max_concurrent_executions.

What runs on the platform's key were charged today (UTC), as Money — the figure daily_limit is measured against.

What runs on the platform's key were charged this calendar month so far (UTC), as Money — the figure monthly_limit is measured against.

The most the account may spend on the platform's key in a calendar month (UTC), as Money. A run that could take the month past it is refused before it starts. Leave it unset for no limit.

The most the account may spend on the platform's key in a calendar day (UTC), as Money. A run that could take the day past it is refused before it starts.

The most runs the account may have queued or running at once, on any connection. A run created past it is refused with CONCURRENCY_LIMIT_REACHED.

The most the account may spend on the platform's key in a calendar month (UTC), as Money. A run that could take the month past it is refused before it starts. Leave it unset for no limit.

The most the account may spend on the platform's key in a calendar day (UTC), as Money. A run that could take the day past it is refused before it starts.

The most runs the account may have queued or running at once, on any connection. A run created past it is refused with CONCURRENCY_LIMIT_REACHED.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

CHARGE for a run on the platform's key; TOP_UP, REFUND, ADJUSTMENT or BONUS for a change made by the platform.

The row's amount as Money, signed: negative for a charge, positive for money put in.

The balance right after this row, as Money, so a statement reads without adding up the rows before it.

The ai_executions entry a CHARGE is for. Absent on every other type.

The ai_usage_records entry — the attempt and its token counts — a CHARGE was priced from.

The price row a CHARGE was priced at. Price rows never change, so a later price change does not restate it.

What the row is for, in words: the run and attempt of a charge, or the reason given for a change.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The ai_executions entry the attempt belongs to.

The number of the attempt within its run, as in the run's attempts.

The ai_agents entry the run executed.

The ai_models entry the attempt ran on.

The AI provider that served the attempt, by the platform's name for it.

Whose key the attempt used: BYOK (the account's own, billed by the provider) or MANAGED (the platform's, charged to the AI balance).

Input tokens the provider counted for the attempt, cache reads and writes not included.

Output tokens the provider counted for the attempt.

Input tokens the provider served from its prompt cache.

Input tokens the provider wrote to its prompt cache.

The provider's own usage object for the attempt, exactly as it arrived, kept beside the four counters above.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The label that tells this agent apart in a list. Required on create unless source_system_agent supplies it.

What the agent is for, for the people who maintain it.

The id of the account's ai_instructions entry this agent runs. Required on create unless source_system_agent is set, which creates the instruction too.

Pin the agent to one version of its instruction. Absent means the instruction's active_version at the moment a run starts.

The ai_models entry a run uses when it does not name a model. Must be AVAILABLE when set, and able to run what this agent asks of it.

The only models a run of this agent may name. Empty means any available model; when not empty, it must include preferred_model_id.

The most tokens one run may write, at most the model's max_output_tokens. Defaults to 16000.

How hard the model is asked to think: LOW, MEDIUM, HIGH, XHIGH or MAX. Leave it unset for the model's default — and on a model without the EFFORT capability, which refuses any level.

TEXT (the default); JSON — an answer that follows output_schema, on a model with STRUCTURED_OUTPUT; or IMAGE — a picture, on a model with IMAGE_GENERATION, whose rendered instruction is the prompt and whose result is an artifact of the run rather than text.

The JSON Schema object a JSON agent's answer must follow. Required when output_format is JSON and refused otherwise.

The width of the picture an IMAGE agent asks for, in pixels, 64 to 4096; defaults to 1024. Refused on a TEXT or JSON agent.

The height of the picture an IMAGE agent asks for, in pixels, 64 to 4096; defaults to 1024. Refused on a TEXT or JSON agent.

How much care an IMAGE agent's picture is drawn with: LOW, MEDIUM, HIGH, XHIGH or MAX. Interpreted by the model's provider: on openai it is the picture's quality, and a higher one produces more output tokens; bfl has no such setting and ignores it. Leave it unset for the provider's default. Refused on a TEXT or JSON agent.

Which of the account's connections a run may be authorized through: ANY (the default), BYOK_ONLY or MANAGED_ONLY.

How many times a run is tried when the provider fails in a way worth retrying: 1 to 10, default 3.

How long one call to the provider may take: a number of seconds with the s suffix, 1s to 600s. Defaults to 120s.

Tools the model may call. Must be empty: tool calling is not available yet.

Whether the agent may run. Switch it off to stop new runs without deleting it.

The configuration's version: 1 on create, and one more on every update. Each version's settings are kept under versions.

The label that tells this agent apart in a list. Required on create unless source_system_agent supplies it.

What the agent is for, for the people who maintain it.

The id of the account's ai_instructions entry this agent runs. Required on create unless source_system_agent is set, which creates the instruction too.

Pin the agent to one version of its instruction. Absent means the instruction's active_version at the moment a run starts.

The ai_models entry a run uses when it does not name a model. Must be AVAILABLE when set, and able to run what this agent asks of it.

The only models a run of this agent may name. Empty means any available model; when not empty, it must include preferred_model_id.

The most tokens one run may write, at most the model's max_output_tokens. Defaults to 16000.

How hard the model is asked to think: LOW, MEDIUM, HIGH, XHIGH or MAX. Leave it unset for the model's default — and on a model without the EFFORT capability, which refuses any level.

TEXT (the default); JSON — an answer that follows output_schema, on a model with STRUCTURED_OUTPUT; or IMAGE — a picture, on a model with IMAGE_GENERATION, whose rendered instruction is the prompt and whose result is an artifact of the run rather than text.

The JSON Schema object a JSON agent's answer must follow. Required when output_format is JSON and refused otherwise.

The width of the picture an IMAGE agent asks for, in pixels, 64 to 4096; defaults to 1024. Refused on a TEXT or JSON agent.

The height of the picture an IMAGE agent asks for, in pixels, 64 to 4096; defaults to 1024. Refused on a TEXT or JSON agent.

How much care an IMAGE agent's picture is drawn with: LOW, MEDIUM, HIGH, XHIGH or MAX. Interpreted by the model's provider: on openai it is the picture's quality, and a higher one produces more output tokens; bfl has no such setting and ignores it. Leave it unset for the provider's default. Refused on a TEXT or JSON agent.

Which of the account's connections a run may be authorized through: ANY (the default), BYOK_ONLY or MANAGED_ONLY.

How many times a run is tried when the provider fails in a way worth retrying: 1 to 10, default 3.

How long one call to the provider may take: a number of seconds with the s suffix, 1s to 600s. Defaults to 120s.

Tools the model may call. Must be empty: tool calling is not available yet.

Whether the agent may run. Switch it off to stop new runs without deleting it.

Create only: the id of an ai_system_agents entry to copy. Its settings and its instruction text — as a new instruction of this account — become the new agent's, under any fields the body also sets.

The label that tells this agent apart in a list. Required on create unless source_system_agent supplies it.

What the agent is for, for the people who maintain it.

The id of the account's ai_instructions entry this agent runs. Required on create unless source_system_agent is set, which creates the instruction too.

Pin the agent to one version of its instruction. Absent means the instruction's active_version at the moment a run starts.

The ai_models entry a run uses when it does not name a model. Must be AVAILABLE when set, and able to run what this agent asks of it.

The only models a run of this agent may name. Empty means any available model; when not empty, it must include preferred_model_id.

The most tokens one run may write, at most the model's max_output_tokens. Defaults to 16000.

How hard the model is asked to think: LOW, MEDIUM, HIGH, XHIGH or MAX. Leave it unset for the model's default — and on a model without the EFFORT capability, which refuses any level.

TEXT (the default); JSON — an answer that follows output_schema, on a model with STRUCTURED_OUTPUT; or IMAGE — a picture, on a model with IMAGE_GENERATION, whose rendered instruction is the prompt and whose result is an artifact of the run rather than text.

The JSON Schema object a JSON agent's answer must follow. Required when output_format is JSON and refused otherwise.

The width of the picture an IMAGE agent asks for, in pixels, 64 to 4096; defaults to 1024. Refused on a TEXT or JSON agent.

The height of the picture an IMAGE agent asks for, in pixels, 64 to 4096; defaults to 1024. Refused on a TEXT or JSON agent.

How much care an IMAGE agent's picture is drawn with: LOW, MEDIUM, HIGH, XHIGH or MAX. Interpreted by the model's provider: on openai it is the picture's quality, and a higher one produces more output tokens; bfl has no such setting and ignores it. Leave it unset for the provider's default. Refused on a TEXT or JSON agent.

Which of the account's connections a run may be authorized through: ANY (the default), BYOK_ONLY or MANAGED_ONLY.

How many times a run is tried when the provider fails in a way worth retrying: 1 to 10, default 3.

How long one call to the provider may take: a number of seconds with the s suffix, 1s to 600s. Defaults to 120s.

Tools the model may call. Must be empty: tool calling is not available yet.

Whether the agent may run. Switch it off to stop new runs without deleting it.

Create only: the id of an ai_system_agents entry to copy. Its settings and its instruction text — as a new instruction of this account — become the new agent's, under any fields the body also sets.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The agent this is a version of. Fixed by the URL.

The version number — also this resource's id, and the version the agent had.

The agent exactly as it stood at this version: every field of the agent resource, except etag.

The user whose write produced this version, as users/{user}.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The AI provider this connection reaches, by the platform's name for it. Set on create and fixed afterwards: a stored key belongs to exactly one provider.

BYOK — your own provider API key, used without touching your AI balance — or MANAGED, the platform's key, charged to the balance. Fixed after create.

The label that tells this connection apart in a list, such as Production key. Free text.

The last four characters of the stored key — the only part of it any response carries, so that two keys can be told apart. Absent on a MANAGED connection, which has no key of its own.

Whether runs may use this connection. Switch it off to stop a key being used without deleting it — and to turn managed access off for the account, since a MANAGED connection cannot be deleted.

The order connections are tried in when an agent may use more than one: lower goes first. Your keys start at 0 and the managed connection at 100, so a key you add is used before your balance is.

What the platform last learned about the key: UNVERIFIED until it is checked, then VALID or INVALID — moved by :verify, and by a run the provider refused for the key's sake. EXPIRED is reserved for providers that report it. Always UNVERIFIED on a MANAGED connection, which has no key of its own to learn anything about.

When status was last decided by asking the provider (RFC 3339, UTC); cleared when the key is replaced, and absent on a MANAGED connection. Sort by it together with a provider filter — that is the pair an index backs.

The label that tells this connection apart in a list, such as Production key. Free text.

The AI provider this connection reaches, by the platform's name for it. Set on create and fixed afterwards: a stored key belongs to exactly one provider.

BYOK — your own provider API key, used without touching your AI balance — or MANAGED, the platform's key, charged to the balance. Fixed after create.

The provider API key. Required when creating a BYOK connection and refused on MANAGED; send it on Update to replace the stored key. It is encrypted before it is stored and no call ever returns it — key_hint is all that comes back.

Whether runs may use this connection. Switch it off to stop a key being used without deleting it — and to turn managed access off for the account, since a MANAGED connection cannot be deleted.

The order connections are tried in when an agent may use more than one: lower goes first. Your keys start at 0 and the managed connection at 100, so a key you add is used before your balance is.

The label that tells this connection apart in a list, such as Production key. Free text.

The provider API key. Required when creating a BYOK connection and refused on MANAGED; send it on Update to replace the stored key. It is encrypted before it is stored and no call ever returns it — key_hint is all that comes back.

Whether runs may use this connection. Switch it off to stop a key being used without deleting it — and to turn managed access off for the account, since a MANAGED connection cannot be deleted.

The order connections are tried in when an agent may use more than one: lower goes first. Your keys start at 0 and the managed connection at 100, so a key you add is used before your balance is.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The id of the account's ai_agents entry this run executes. Set on create and fixed afterwards.

The version of the agent this run uses, resolved when the run was created. Its settings are kept under the agent's versions, so the run can be reproduced after the agent changes.

The version of the agent's instruction whose text this run uses, resolved when the run was created.

The ai_models entry the run uses. Leave it out to use the agent's preferred_model_id; when the agent lists allowed_model_ids, only those can be named.

The AI provider of the run's model, by the platform's name for it.

What the run works on: variables, an object filling every {{variable}} the instruction uses (strings, integers or booleans), and optionally text — material for the instruction to act on, such as a page to translate.

QUEUED, RUNNING, then SUCCEEDED, FAILED, CANCELLED or EXPIRED. A retryable failure puts the run back to QUEUED until its attempts run out.

The ai_connections entry the latest attempt was authorized through. Absent until an attempt was routed.

Whose key the latest attempt used: BYOK (the account's own) or MANAGED (the platform's, paid from the AI balance).

What the run consumed, summed over every attempt that reported it: input_tokens, output_tokens, cache_read_input_tokens, cache_creation_input_tokens, and for an IMAGE run image_count and megapixels_milli (thousandths of a megapixel).

What the run was charged to the AI balance, summed over its attempts, as Money. Present once an attempt on the platform's key (MANAGED) was charged; a run on the account's own key has no cost here, because the provider bills the account directly.

The result of a SUCCEEDED run: text, or json for an agent with output_format JSON, or artifacts for an IMAGE agent — each with its storage_key, mime_type, width, height and byte_size, the bytes living in the platform's store — and output_truncated, true when a text answer stopped at max_tokens.

Why a FAILED or EXPIRED run stopped, in the same shape as an API error: code, status, message and, where there is one, a PRECONDITION_FAILURE whose type says why.

Every attempt, in order: number, start_time, end_time, http_status (0 when no response arrived), error_code, message, and usage when the attempt's usage is known.

Who started the run, in the caller's own words — editorial, import. Stored and filterable, never interpreted. Fixed after create.

The caller's own reference for what the run is for, within source_module, which it requires. Filter by it together with source_module.

Any other correlation the caller wants back with the run, as an object of at most 16 KB. Returned as sent; not filterable.

A deadline for starting: a run not started by then becomes EXPIRED without calling the provider (RFC 3339, UTC). Sort by it together with a state filter.

When the first attempt started (RFC 3339, UTC).

When the run reached the state it is in, if that state is final (RFC 3339, UTC).

The id of the account's ai_agents entry this run executes. Set on create and fixed afterwards.

What the run works on: variables, an object filling every {{variable}} the instruction uses (strings, integers or booleans), and optionally text — material for the instruction to act on, such as a page to translate.

The ai_models entry the run uses. Leave it out to use the agent's preferred_model_id; when the agent lists allowed_model_ids, only those can be named.

Who started the run, in the caller's own words — editorial, import. Stored and filterable, never interpreted. Fixed after create.

The caller's own reference for what the run is for, within source_module, which it requires. Filter by it together with source_module.

Any other correlation the caller wants back with the run, as an object of at most 16 KB. Returned as sent; not filterable.

A deadline for starting: a run not started by then becomes EXPIRED without calling the provider (RFC 3339, UTC). Sort by it together with a state filter.

An idempotency key you choose, at most 64 characters. Creating with a key already used returns the run that key created instead of starting another.

The id of the account's ai_agents entry this run executes. Set on create and fixed afterwards.

The ai_models entry the run uses. Leave it out to use the agent's preferred_model_id; when the agent lists allowed_model_ids, only those can be named.

What the run works on: variables, an object filling every {{variable}} the instruction uses (strings, integers or booleans), and optionally text — material for the instruction to act on, such as a page to translate.

Who started the run, in the caller's own words — editorial, import. Stored and filterable, never interpreted. Fixed after create.

The caller's own reference for what the run is for, within source_module, which it requires. Filter by it together with source_module.

Any other correlation the caller wants back with the run, as an object of at most 16 KB. Returned as sent; not filterable.

A deadline for starting: a run not started by then becomes EXPIRED without calling the provider (RFC 3339, UTC). Sort by it together with a state filter.

An idempotency key you choose, at most 64 characters. Creating with a key already used returns the run that key created instead of starting another.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The label that tells this instruction apart in a list. Free text.

What the instruction is for, for the people who maintain it.

The variable names the text may reference as {{name}}: lower-case letters, digits and _. A version that references a name not listed here is refused, and so is a run that supplies one — or leaves a referenced one out.

The version a run uses unless its agent pins another. The first version becomes active by itself; after that, set this field to switch. Absent until a version exists.

The label that tells this instruction apart in a list. Free text.

What the instruction is for, for the people who maintain it.

The variable names the text may reference as {{name}}: lower-case letters, digits and _. A version that references a name not listed here is refused, and so is a run that supplies one — or leaves a referenced one out.

The version a run uses unless its agent pins another. The first version becomes active by itself; after that, set this field to switch. Absent until a version exists.

The label that tells this instruction apart in a list. Free text.

What the instruction is for, for the people who maintain it.

The variable names the text may reference as {{name}}: lower-case letters, digits and _. A version that references a name not listed here is refused, and so is a run that supplies one — or leaves a referenced one out.

The version a run uses unless its agent pins another. The first version becomes active by itself; after that, set this field to switch. Absent until a version exists.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The instruction this is a version of. Fixed by the URL.

The version number — also this resource's id. Assigned by the server: one more than the instruction's latest.

The template text. {{name}} is replaced by the run's value for name, which must be one of the instruction's variables; any other text, other braces included, is sent as written.

Why this version exists — the one thing a comparison of two texts cannot tell you.

The user who wrote this version, as users/{user}.

The template text. {{name}} is replaced by the run's value for name, which must be one of the instruction's variables; any other text, other braces included, is sent as written.

Why this version exists — the one thing a comparison of two texts cannot tell you.

The template text. {{name}} is replaced by the run's value for name, which must be one of the instruction's variables; any other text, other braces included, is sent as written.

Why this version exists — the one thing a comparison of two texts cannot tell you.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The provider that serves this model, by the platform's name for it.

The provider's own identifier for the model — what a run sends it. It can move to a newer snapshot of the model while id, the name agents store, stays the same.

The model's name as a person reads it, for a picker.

What the model can do. TEXT_GENERATION to run a text agent at all; STRUCTURED_OUTPUT to run an agent whose output_format is JSON; EFFORT to accept an agent's effort; IMAGE_GENERATION to run an IMAGE agent; VISION and TOOL_CALLING are listed for later use.

The largest prompt the model accepts, in tokens.

The largest max_tokens an agent may set and still run on this model.

AVAILABLE models run. DEPRECATED and DISABLED ones do not, and an agent cannot be pointed at one — the platform takes a model out of service with this field, without a release.

A rough place on the speed-to-capability scale: FAST, BALANCED or POWERFUL.

Whether the platform has a price for what this model does — for an IMAGE_GENERATION model, a price for pictures in the unit its provider bills them by (per picture, or by tokens) — so a run on the platform's key can be charged. When it is false, a run on the platform's key is refused with MODEL_NOT_PRICED, and the model runs only on the account's own connection to its provider.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The agent's name as a person reads it.

What the agent is for, in a sentence or two.

The agent's prompt template, with {{variable}} references. A copy of the agent starts from this text as version 1 of its own instruction.

Which revision of instruction_text this is; it rises whenever the platform changes the text.

The variable names instruction_text references — the values a run of this agent is given.

The model a run uses when it does not name one.

The only models a run may name; empty means any available model.

Tools the model may call. Always empty: tool calling is not available yet.

The most tokens one run may write.

How hard the model is asked to think: LOW to MAX. Absent means the model's own default.

TEXT, JSON constrained by output_schema, or IMAGE — a picture of image_width by image_height.

The JSON Schema a JSON agent's answer follows. Present only when output_format is JSON.

The width of the picture an IMAGE template asks for, in pixels. Present only on an IMAGE template.

The height of the picture an IMAGE template asks for, in pixels. Present only on an IMAGE template.

Which connections a run may be paid through: ANY, BYOK_ONLY or MANAGED_ONLY.

How many times a run is tried when the provider fails in a way worth retrying.

How long one call to the provider may take, as a duration in seconds.

Whether the platform offers this agent. One that is switched off cannot be copied.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The metric's name as a person reads it, for a widget's title or a picker.

What the number means and — just as importantly — what it leaves out, in a sentence or two a widget can show as help text.

What the number is measured in. COUNT is the only unit today; it is an enum because response times and rates are the next metrics and they are not counts.

EXACT for a counter, ESTIMATED for a number computed from a sketch. Everything ESTIMATED answers approximate: true on :query, and is accurate to about 1.6 %.

The steps :query can return a series in: MINUTE, HOUR, DAY. Empty means the metric is a single number and its answer carries no points at all.

The windows :query accepts: TODAY, LAST_7_DAYS, LAST_30_DAYS, CUSTOM. Empty means the metric measures its own window ending now and takes no period.

The step :query returns when the caller names no interval — except for TODAY, which steps by HOUR so that today is a shape rather than one bar. Absent on a metric with no series.

For a live metric, the window it always measures, as a duration in seconds (300s). Absent on every metric that takes a period instead.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The name this is shown under, on the site and in the admin.

The URL segment this is addressed by on the live site. Unique among its siblings, and a view may override it so a translated page gets a translated URL.

Whether the author is shown on the site. It is one of the two fields a view cannot override, so an author is hidden everywhere or nowhere.

The short biography rendered under the byline and on the author's own page.

The media resource used as the author's portrait.

Who the author's own page is for, with the values of a post's audience. It hides the author's page, their place in the author list and their byline from other readers; the posts they wrote stay as visible as they are, shown without the byline.

The customer_groups of the website a GROUPS audience is for — at least one, at most 100. Empty for any other audience: setting the audience to anything else empties it, and a deleted group drops out of it on its own.

The name this is shown under, on the site and in the admin.

The URL segment this is addressed by on the live site. Unique among its siblings, and a view may override it so a translated page gets a translated URL.

Whether the author is shown on the site. It is one of the two fields a view cannot override, so an author is hidden everywhere or nowhere.

The short biography rendered under the byline and on the author's own page.

The media resource used as the author's portrait.

Who the author's own page is for, with the values of a post's audience. It hides the author's page, their place in the author list and their byline from other readers; the posts they wrote stay as visible as they are, shown without the byline.

The customer_groups of the website a GROUPS audience is for — at least one, at most 100. Empty for any other audience: setting the audience to anything else empties it, and a deleted group drops out of it on its own.

The name this is shown under, on the site and in the admin.

The URL segment this is addressed by on the live site. Unique among its siblings, and a view may override it so a translated page gets a translated URL.

Whether the author is shown on the site. It is one of the two fields a view cannot override, so an author is hidden everywhere or nowhere.

The short biography rendered under the byline and on the author's own page.

The media resource used as the author's portrait.

Who the author's own page is for, with the values of a post's audience. It hides the author's page, their place in the author list and their byline from other readers; the posts they wrote stay as visible as they are, shown without the byline.

The customer_groups of the website a GROUPS audience is for — at least one, at most 100. Empty for any other audience: setting the audience to anything else empties it, and a deleted group drops out of it on its own.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The overlay's own storage id, kept for clients that stored it before the overlay had a resource name.

The resource this overlay belongs to. Fixed by the URL — an overlay cannot change master.

The view this overlay speaks for. Fixed by the URL.

The names of the fields this view actually overrides. A field counts as overridden only while it is listed here — an empty value with the field absent from this list means "use the master", not "show nothing".

This view's name for the resource.

This view's biography for the author.

This view's URL segment for the author's page.

The names of the fields this view actually overrides. A field counts as overridden only while it is listed here — an empty value with the field absent from this list means "use the master", not "show nothing".

This view's name for the resource.

This view's biography for the author.

This view's URL segment for the author's page.

The names of the fields this view actually overrides. A field counts as overridden only while it is listed here — an empty value with the field absent from this list means "use the master", not "show nothing".

This view's name for the resource.

This view's biography for the author.

This view's URL segment for the author's page.

The resource name (§5) — the identity of this resource, and the path that addresses it: websites/{website}/cms_pages/{cms_page}. It is the handle to store, not a human label.

The last segment of name on its own, for a client that needs to build a child URL. Unique inside its parent, never across the platform.

When the resource was created (RFC 3339, UTC).

When the resource last changed (RFC 3339, UTC).

Version of the persisted state. Send it back in If-Match on Update or Delete and the write is rejected with ABORTED if anyone else changed the resource meanwhile (§14).

The name this is shown under, on the site and in the admin.

The URL segment this is addressed by on the live site. Unique among its siblings, and a view may override it so a translated page gets a translated URL.

The category this one hangs under; empty at the root. Settable on create and immutable afterwards — moving a category is :move, which recomputes the whole subtree.

The category's position in the tree: the ids of its ancestors and its own, in order. Sorting by it is what renders a whole tree in one page.

The category's full URL path on the live site — its own slug behind the slugs of its ancestors.

How deep the category sits, counting the root as 0. Server-maintained, like the rest of the tree bookkeeping.

The category's position among its siblings. Set by :move, never by a write.

The blurb rendered on the category's own page.

Whether the category is shown. Hiding one hides its whole subtree on the site.

The views this category appears in. Empty means every view, not none.

Who the category is for, with the values of a post's audience. It narrows the whole subtree: a subcategory, and every post in the category or below it, reaches only readers this category is for too — the strictest audience on the way up wins. A category not everybody may read is left out of the sitemap, the menus of anonymous visitors and every cached copy of the blog.

The customer_groups of the website a GROUPS audience is for — at least one, at most 100. Empty for any other audience: setting the audience to anything else empties it, and a deleted group drops out of it on its own.

The name this is shown under, on the site and in the admin.

The URL segment this is addressed by on the live site. Unique among its siblings, and a view may override it so a translated page gets a translated URL.

Whether the category is shown. Hiding one hides its whole subtree on the site.

The category this one hangs under; empty at the root. Settable on create and immutable afterwards — moving a category is :move, which recomputes the whole subtree.

The blurb rendered on the category's own page.